Plugin X10

From VoxCommando
Jump to: navigation, search

For general information about using X10 with VoxCommando please visit the X10 page

Go to the main Plugins page.

Go to the complete Plugin List.


Plugin Description

Sends commands to X10 Home Automation devices. Can also generate events based on X10 events. Tested with CM15A USB transceiver. Other transceivers may also work.

Requires installation of the ActiveHome Pro SDK: http://voxcommando.com/files/ahsdk_install.exe

Actions for the X10 plugin

SendAny

X10.SendAny
The X10.SendAny action allows you to specify any <Type> of <Command> to send in case you wish to use a command other than SendPlc, SendRf, or QueryPlc. Some other command types that *might* work (with the correct command) are: SendSecureRf, SendSecureHomeControlRf, SendIr

Example:
<Type> SendSecureRf
<Command> homearmdelayed standard 100

  • Parameters: 2
  1. Type : Type of command to send, example: SendPlc [string]
  2. Command : Command string. See description for examples [string]

SendPlc

X10.SendPlc
Sends the PLC (Power line command) <Command> to the X10 interface.

Example command strings:

A1 ON
B3 DIM 20
A5 BRIGHT 40
C1 ALLUNITSOFF

  • Parameters: 1
  1. Command : Command string. See description for examples [string]

SendRf

X10.SendRf
Sends the RF (Radio Frequency) <Command> to the X10 interface.

Example command strings:

A1 ON
B3 DIM 20
A5 BRIGHT 40
C1 ALLUNITSOFF

  • Parameters: 1
  1. Command : Command string. See description for examples [string]

QueryPlc

X10.QueryPlc
Ask the X10 service the status of any address. There are two kinds of status to check:
- On status: <X10 address> on
- Dim level: <X10 address> dim
Specifying the "on" parameter returns 0 if off, 1 if on. Dim returns the dim level as a percentage of full brightness.. Both functions return -1 if the current status is not known.

Example to check if A1 is on [0] or off [1]:
A1 ON

  • Parameters: 1
  1. Command : Query command string [string]