[Help Index]

 MSN/CommandPrompt/Script Command Reference :


In X10Dispatcher, commands are used in various places :
  • In the program console, where you control dispatcher via text entry (Remote Cmds tab)
  • From MSN, where you converse with dispatcher using these commands
  • From Dispatcher Scripts; Multiple commands entered into a text file can be executed as an action or macro.

Commands were originally exclusive to MSN but they have value that extends to directly interfacing with the console, as well as for automation (and external interfacing) via scripts.

Using the commands via MSN usually requires enabling their 'remote' execution in the settings screen while all commands are typically enabled by default for Console and scripting purposes.

The Commands with Dispatcher currently support include :
  • Help : Displays a list of all commands (Applicable only to : Console, MSN)
  • Ver : Displays the X10Dispatcher version number. (Applicable only to : Console, MSN)
  • Arm and Disarm : You can use these commands to remotely Arm and Disarm the system via MSN messenger.
  • History : this will display the last 1500 characters of x10 activity (approximately 50 events). The program itself maintains about 16K (~500 commands), but MSN sets a limit to how large messages can be, so 1500 it is for now.
    (Applicable only to : Console, MSN)
  • Emp1/2/3/4 : this command instructs X10 Dispatcher to email you the picture in slot 1-4 to the email address specified in the Email tab.  If you have configured a picturephone address, then that is the address it will send to instead.  From my cell phone i can do both, connect and request an image via MSN, and have the image sent to my picturephone email address on that same phone.
    Example : emp3
  • Send [Image1/Image2/Image3/Image4] : This feature tells x10dispatcher to send you the current picture in the specified image slot through MSN. The image will be sent as a file transfer. MSN file transfers are more picky about firewalls/routers although you 'should' be able to remotely access these unless your 'away' computer is a business which imposes a firewall. Home users who are behind a router may also find the first transfer takes around 30 seconds to begin while MSN determines you are using a router and adjusts accordingly to allow the transfer.
    Example : send image3
    (Applicable only to : MSN)
  • Clear History : this will clear the x10dispatcher event history.
  • Cycle Service : this allows you to shutdown and restart the x10nets windows service (if you are running Windows 2000 or XP). If for some reason the CM15a becomes unresponsive, this may allow you to re-enable its functionality. This is most experimental right now but there have been several instances where my macros stop firing and this returned their responsiveness. Independently from this MSN Command, x10dispatcher also checks whether this service is running when it starts up and if it is not, it will start it itself. This may allow you to configure rebooting situations and avoid running AHP to initialize driver/service (assuming you autostart x10dispatcher).
  • Sendplc [device] [command] : This feature lets you send X10 commands over your powerline using MSN.  So if you forgot turn a lamp off you might send the MSN Message sendplc b1 on to turn on a lamp with on device b1.
  • Eaves [On/Off] : tells x10dispatcher to begin caching and forwarding all x10 activity (whether there is a trigger or not) at a throughtput of 1500chars per 30 seconds. You will not see activity instantly but 30 second max response time is not bad. The program will continue notifying you of activity until you use the 'eaves off' command.
  • Request IP : This feature allows you to find out what your home computer IP address is. This can be useful if you are running servers at home. If you are on a behind a firewall, you may choose to have x10 dispatcher look at one of many web based ip checker webpages (one is provided by default) to determine programmatically and forward that ip address to you. If behind firewall remember to forward the ports your server programs are using.
    (Applicable only to : Console, MSN)
  • Stats : displays statistical information such as system arm status, number of events heard, number of triggers fired, number of alerts sent to msn/email.
    (Applicable only to : Console, MSN)
  • Reset WebAlerts : (See WebAlert feature(s) below). Once a webalert fires, it will be suppressed from firing again until webalerts are reset either from the user interface or this remote command. Each webalerts remains active until it fires, it is then dispatched and further supressed, and resetting webalerts is done as a single action to all webalerts.
  • Reset PowerAlerts : If you have configured Power Alerts to only send one power off/on message, this allows the next off/on alert to be sent.  
  • Notes : The user interface contains a multiline text area in the notes tab. This command will forward all text (limited to 1500 chars) of text which is contained in that text field. This is mostly useful for sending links to yourself. Use in conjunction with ’Add Notes’ feature below.
  • Add Note [Note Text]: Allows you to add a line of text to the Notes tab of the User Interface. Useful for ’sending home’ information like links, while you are away.
  • ExtNotes : displays the contents of the external notes file (usually caller id log).
    (Applicable only to : Console, MSN)
  • TTSSpeak [message] : announces a custom text message on the home computer.
    Example : 'ttsspeak this is me talking from work.  i am heading home and i will stop and pick up some pizza.'
  • RunMacro [Macro Name] : executes a Dispatch Macro.
    (Applicable only to : Console, MSN)
  • SetVariable [VarName=VarValue] : sets a dispatcher variable names VarName to a string specified by VarValue.
  • ShowVars : displays a list of all currently maintained dispatcher user variables and their values.
    (Applicable to : Console, MSN)
  • ClearVars : Clears all dispatcher variables from memory.