The PERL home automation software system !
		Back to Main

Usage:

http://audreyip/fireKey.shtml?string=

('string='is part of the required syntax)

string=([printable char] | [@@] | [@b] [@key] [@xhhhh] [@ctlon] [@ctloff] [@shifton] [@shiftoff] [@alton] [@altoff])*

@@=@ sign

@b = space (case sensitive)

@Xhhhh:

hex digits(h) follow,

This becomes the hex escape of what gets sent, for example

@XF0C1

hex A-F MUST BE UPPERCASE!

See /usr/include/photon/PkKeyDef.h for hex key values

@key, key is name of key, such as   (case sensitive) :

@BRW - Browser	@ADR - address book	@DAT - datebook
@OPT - Audrey options	@PWR - Power button (not sure if this works)
@KLF - Turn Knob left	@KPS - Push knob	@KRT - Turn knob right
@MAIL - email button	@TAB - TAB	@ENT - Enter

Not sure if the following actually works or not.

@shifton - subsequent chars have shift on

@shiftoff - subsequent chars have shift off

(same for alton/altoff and ctrlon/ctrloff) 

Also, doesn't quite work right

@pause = sleep for 1 second$MHWeb/toAudrey.wav , however, this seems to put the process to sleep before the events get fired, so use at your own risk.

"beep" is a quick utility to play the Audrey's built-in short sound effects,
or customized sounds. The Audrey has a small library of clicks, chirps, and
beeps used by the various native applications. This utility is a very
lightweight way of playing those sound effects, without the need to launch
phplay or some other application. You can change which sounds are played by
overwriting the default sound effects with sounds of your own (see table below
for naming). The source code to implement this is very small, and can easily
be integrated into any application without the need to link to any kojak or
photon libraries. All that's required for this to work is to have the
/kojak/bleep resource manager running (check ps to make sure).

beep 0 Y   Play sound Y, where Y is from 0 to 18.  See below for names.
beep 1     Stop any playing sound effects.
beep 2     Disable any beep sound effects until re-enabled
beep 3     Enable beep sound effects.
beep 4 Y   Set sound volume to Y%, where Y is between 0 and 100.

Table of sounds playable with "beep 0 Y", where Y is one of the following:

0:   /tmp/snd/cancel-PCM.wav
1:   /tmp/snd/check-PCM.wav
2:   /tmp/snd/copy-PCM.wav
3:   /tmp/snd/cut-PCM.wav
4:   /tmp/snd/delete-PCM.wav
5:   /tmp/snd/help-PCM.wav
6:   /tmp/snd/major_high-PCM.wav
7:   /tmp/snd/menu_close-PCM.wav
8:   /tmp/snd/menu_open-PCM.wav
9:   /tmp/snd/minor_high-PCM.wav
10:  /tmp/snd/minor_low-PCM.wav
11:  /tmp/snd/paste-PCM.wav
12:  /tmp/snd/print-PCM.wav
13:  /tmp/snd/scroll_down_left-PCM.wav
14:  /tmp/snd/scroll_up_right-PCM.wav
15:  /tmp/snd/snapshot-PCM.wav
16:  /tmp/snd/warning-PCM.wav
17:  /tmp/snd/go_to_sleep-PCM.wav
18:  /tmp/snd/wake_up-PCM.wav

Note that when the resource manager starts up at Audrey startup, this
/tmp/snd directory is copied directly from /kojak/snd. You can replace
files in /tmp/snd without fear of permanently losing the original sounds.
However, your replacements will be overwritten each time Audrey reboots.
To permanently replace the sounds, put them in /kojak/snd with one of the
above names. (You might want to save off the original sound just in case).

Usage

http://YourAudreyIP/beep.shtml?0 2        (plays sound 2)
http://YourAudreyIP/beep.shtml?4 75       (turns volume to 75%)

"screen" is a utility to control and monitor the Audrey's LCD screen from the command line,
or remotely through the web server. Note that this program actually puts the Audrey into
and out of sleep mode, unlike calls to gpio. It can be used to go into sleep mode or wake
up at pre-set times by using cron, or by applications who's functionality depends on
knowing the state of the screen. This program uses the IPC system devised by 3Com to
control the LCD, and so it requires the built-in library called libkojak.so, which is
normally in /nto/lib.

Usage

http://YourAudreysIP/screen.shtml?0   (Go to sleep)
http://YourAudreysIP/screen.shtml?1   (Wake up)
http://YourAudreysIP/screen.shtml?t   (Toggle sleep mode)
http://YourAudreysIP/screen.shtml?p   (Print current state.  0 or 1 will show in the browser)

"led" is a quick utility to control the Audrey's mail and stylus LEDs from the command
line. Note that this program can control the two LEDs independently, unlike SetLEDState.
It can be useful for various applications to set either light to ON, FLASHING, or OFF
without affecting the other light, since this allows more information to be relayed at
a glance from across the room. The only requirement is that /kojak/ledmgr must be running
on the Audrey (this is a default driver).

led -t 1        -- turn on top LED
led -m 2        -- make mail LED flash
led -m 1 -t 2   -- turn mail LED on, flash top LED
led -m 0 -t 0   -- turn both LEDs off

Usage

http://YourAudreysIP/led.shtml?t1m2   (top LED on, mail LED flashing)
http://YourAudreysIP/led.shtml?t0     (top LED off, leaving mail flashing)
http://YourAudreysIP/led.shtml?m1     (mail LED to solid on)

These functions allow you to push speech (wav files) to your Audrey.  The preferred command is the mhspeak.shtml, as it runs at a higher priority, and is less likeley to break up if the Audrey is busy processing something else.
The .wav file generally is generated by MisterHouse speech server software.

Usage

http://YourAudreysIP/mhspeak.shtml?http://location.of/wavefile.wav

The full MisterHouse Syntax is (typically):

run "get_url -quiet http://$ip/mhspeak.shtml?http://$MHWeb/toAudrey.wav /dev/null";

Unlike the beep utility this will allow you to control the master volume on the audrey, not just the volume of the internal sounds

Usage:

http://audreyIP/volume?x      the value of x=0 to 100 represents the precentage of volume  0 - 100%