Differences

This shows you the differences between two versions of the page.

--- x10port [2008/09/18 21:15] – created sestst
+++ x10port [2018/11/03 02:59] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
-{{port64.png|}}
+{{:pci_card64.png| Hardware Item}}
-====== X10Lamp ======
+====== X10Port ======
-This module is a part of the [[NetHomeServer]]. The X10Lamp is not yet documented.
+This module is a part of the [[:start|NetHomeServer]]. The X10Port manages the connection to the CM12-interface module via a serial port. The CM12-interface module can send and receive X10 commands over the mains wires. Recieved X10 messages are transmitted as Events over the internal NetHomeServer event bus. The X10 protocol uses separate address and function messages and the actual devices knows who is currently addressed. The X10Port hides this for outgoing messages.
 ===== Attributes =====
-  * **State** //[get]//
+  * **ComPort** //[get] [set]// Serial port where the CM12 is connected. For example COM1 on windows or /dev/ttyUSB0 on Linux
-  * **HouseCode** //[get] [set]//
+  * **State** //[get]// Current connection state to the hardware device, "Connected" or "Not Connected"
-  * **DeviceCode** //[get] [set]//
+  * **ReceivedMessages** //[get]// Number of received messages
-  * **X10Port** //[get] [set]//
+  * **SentMessages** //[get]// Number of sent messages
 ===== Actions =====
-  * **on**
+  * **reconnect**  Tries to reconnect if the connection to the interface failed at startup.
-  * **off**
+===== Events =====
-  * **bright**
+  * Emits **X10Address(HouseCode, DeviceCode)** This event is emitted when an X10 address command is received from the CM12.
-  * **dim**
+  * Emits **X10Function(X10Type, HouseCode, DeviceCode)** This event is emitted when an X10 function command is received from the CM12. The command is directed to the device addressed by the last X10Address command.
-  * **toggle**
-  * **dimLoop**
+Note: All received events heed the "Target" attribute if it is specified. The received events can be considered an internal interface, please use the corresponding [[X10Lamp]] or [[X10Scene]] to control devices.
+  * Receives **X10AllLightsOff(HouseCode)** Turns off all X10 devices regarded as lamps with the specified HouseCode
+  * Receives **X10AllLightsOn(HouseCode)** Turns on all X10 devices regarded as lamps with the specified HouseCode
+  * Receives **X10AllUnitsOff(HouseCode)** Turns off all X10 devices with the specified HouseCode
+  * Receives **X10PresetDim1(HouseCode)** Switches all X10 devices with the specified HouseCode to preset Dim state 1
+  * Receives **X10PresetDim2(HouseCode)** Switches all X10 devices with the specified HouseCode to preset Dim state 2
+  * Receives **X10SwitchUnitOff(HouseCode, DeviceCode)** Turns off the specified X10 device
+  * Receives **X10SwitchUnitOn(HouseCode, DeviceCode)** Turns on the specified X10 device
+  * Receives **X10BrightUnit(HouseCode, DeviceCode)** Brights the specified X10 device
+  * Receives **X10DimUnit(HouseCode, DeviceCode)** Dims the specified X10 device
 ==== See also ====
-[[NetHomeServer]]
+[[:start|NetHomeServer]], [[X10Lamp]], [[X10]]