# IPS-868 > Symcon documentation · English · generated on 2026-09-26 > Index: https://www.symcon.de/en/llms.txt Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/ With its bidirectional radio components, the IP-Symcon radio system 868 supplements areas of application that are often not satisfactorily covered by other systems. This includes consumption recording via the S0 input, presence control via the PresenceControlModule including a tracker, analysis of the room air via an air quality sensor, and the control of LED strips. > **Note:** The following devices are supported by IP-Symcon: > > [supported devices](ips-868.md) ### Installation The __USB Gateway__ is connected to the PC via USB. The necessary drivers are available from SiLabs for [download](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers) . After its installation, the gateway is ready for use. The __LAN Gateway__ is connected to the PC via LAN. By default, DHCP and port 5000 are set up. If an individual IP address is required, the IP-Symcon "Network Configuration Tool" is required. This is available for [download](https://support.symcon.de/lan-gct) . A simple [description of how to configure the gateway](https://www.symcon.de/assets/files/service/NetworkConfigurationTool.pdf) is available. The gateway can then be reached via the corresponding IP address and port. > **Note:** If no IP-Symcon house is printed on the front of the LAN gateway, it is an older model of the gateway. The installation instructions for this model can be found [here](https://www.symcon.de/assets/files/service/IPS868LAN-Gatewayrev.vor2015.pdf) . ### Integration in IP-Symcon When using the LAN gateway, this can be integrated via the [Device Search](../components/management-console.md). To do this, "IPS-868 Discovery" must be selected as the system. The discovery instance then offers to create an IPS-868 [Configurator](../concepts.md). After the configurator has been created, the individual devices can be integrated there as described below. The USB gateway is created directly as a configurator because it cannot be found via the [Device search](../components/management-console.md). For this purpose, an "IPS-868 Configurator" is created in the [Object Tree](../components/management-console.md). When configuring the interface, the "IPS-868 USB Gateway" mode must be selected and then the appropriate port selected and opened. ### Configurator All IPS-868 devices can be created as [Instance](../concepts.md) using the IPS-868 configurator. To do this, "New device" must be selected from the list and "Create" clicked on. ![IPS-868 configurator](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/geraete/ips-868/5bcc5dd6fb-1790424938/ips868-konfigurator.png) New [Instances](../concepts.md) are created in the [Object Tree](../components/management-console.md) in the main category. These created instances can then be renamed accordingly and sorted elsewhere. A newly added device can be configured via "Configure". Here, on the one hand, the device ID must be entered here and, depending on the device, other device-specific properties may have to be defined. The exact procedure and the device ID can be found in the documentation of the respective device. ([device list](ips-868.md) ) ![IPS-868 configuration](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/geraete/ips-868/294249873c-1790424938/ips-868-konfig.png) ### Configuration Various properties can be set on the configuration page of the device. These can be found in more detail in the respective device documentation. | Device Instance | Device description | | ---------------------------- | -------------------------------------------------------- | | ACC-868 | -------------------------------------------------------- | | AKM-868 (Tracker) | [AKM-868](ips-868.md) | | ANA-868 (Analog-Output) | [ANA-868](ips-868.md) | | ANA-868 (Analog-Input) | [ANA-868](ips-868.md) | | DATA-868 | -------------------------------------------------------- | | EKM-868 (Counter) | [EKM-868](ips-868.md) | | FD-868 (Display Input) | [FD-868](ips-868.md) | | FD-868 (Display Output) | [FD-868](ips-868.md) | | FD-868 (Display) | [FD-868](ips-868.md) | | JKM-868 (LevelJET) | [JKM-868-LevelJET](ips-868.md) | | JKM-868 (ThermoJET) | [JKM-868-ThermoJET](ips-868.md) | | LGS-868 (Air Quality Sensor) | [LGS-868](ips-868.md) | | RGBW-868 (Stripe) | [RGBW-868](ips-868.md) | | RGBW-868 (Stripe Input) | [RGBW-868](ips-868.md) | | SERVO-868 | [SERVO-868](ips-868.md) | | SERVO-868 (Input) | [SERVO-868](ips-868.md) | | TFK-868 (Input) | -------------------------------------------------------- | | WDT-868 (WatchDog) | [WDT-868](ips-868.md) | ## AKM-868 Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/akm-868/ ### Description The presence control module AKM 868 consists of a small remote control in keychain format in an oval housing (size: 55 * 44 * 15 mm) and a repeater. The remote has a button with a dual function: short and long press. This enables two devices (e.g. light and a garage door) to be switched on or off. The special feature of this handset is that it sends a 'ping' approximately every 40 seconds. It consists of a unique ID, which is analyzed by IP Symcon. If the tracker is no longer within range, a corresponding variable is set to FALSE after five minutes. In this way, certain scenarios can be started when leaving or entering the apartment. The battery lasts at least six months - according to current knowledge even more than a year (pure ping operation). Data is transmitted via the 868 MHz frequency band. ### Installation In order to be able to receive data, an 868 Gateway (LAN or USB) must first be connected and set up. "AKM-868 (Tracker)" must be added in IP-Symcon. The parent instances (e.g. the gateway) are created automatically. ### Configuration To use the device in IP Symcon, add a new AKM-868 instance (manufacturer: IP Symcon/ ProJet): * __DeviceID:__ As standard 0 is specified. This means that of all the repeaters data can be received. To specifically select a device, e.g. the 160 can be selected. Jumper assignment (view in the device, antenna above, bottom 2 jumpers pairs): 160: both open 161: right closed 162: left closed 163: both closed * __TrackerID:__ To change the ID, the button must be held down while inserting the battery. The ID is automatically generated by the tracker. This is retained even after a battery change. Most of the time the TrackerID is: 8191 (Default) If a 'ping' is received, 'Available' is automatically set to TRUE, and in addition, the time stamp in 'Update' updated. If no 'Ping' signals are received for more than five minutes (fixed, unchangeable), 'Available' is set to FALSE. Additionally, the key shots are evaluated. (For 'Special' both buttons are pressed simultaneously - old version: with two keys.) > **Note:** Note that the key variables always remain TRUE and only the timestamp changes. ![tree-pj-tracker](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/geraete/ips-868/akm-868/8ae34a7894-1790424938/tree-pj-tracker.png) ### Tips & Tricks * The receiver sensitivity of the repeater can be set to "HI / LO". To do this, the jumper next to the ATMEL processor must be bridged (low reception sensitivity). If the transmission power is low (LO), the approximate position of the remote control can be determined with a second or third AKM. Of course, this is highly dependent on the respective local conditions. However, a distinction - such as basement, garden or upper floor - should be possible. * In order to significantly increase the range of the remote control, the SMD antenna can be replaced by a wire antenna (_Lambda district: 87mm_). This is available from us on request. ###Troubleshooting * If the tracker is not recognized despite a new battery, the TrackerID must be reassigned (see above) and then re-taught in the tracker module with "Search". ## ANA-868 Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/ana-868/ The analogue-digital/ digital-analogue converter module has 2 analogue inputs (10V, input impedance 10kOhm) and 2 analogue outputs (10V/10mA). ### Installation In order to read in the data from measured voltages or to be able to set voltages at the outputs, an 868 Gateway must first be connected and set up. An "ANA-868 (analog input/ analog output)" module must be added in IP-Symcon. The parent instances (e.g. the gateway) are created/connected automatically. ### Configuration | Value | Description | | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Device Address | The ID:184 is specified by default. If there are more controllers in a system, a new ID must be assigned. The jumper assignment can be found in the operating instructions. | | Channel Address | (1-4) Indicates which of the two output/input channels should be used. | ## PJ_RequestStatus Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/ana-868/pj-requeststatus/ `bool PJ_RequestStatus(int $InstanceID)` Query the status of variables and set them **Parameters** - `$InstanceID` (int): Device ID **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. Device ID **Example** ```php //Queries the current values of instance 12345. PJ_RequestStatus(12345); ``` ## PJ_SetVoltage Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/ana-868/pj-setvoltage/ `bool PJ_SetVoltage(int $InstanceID, float $Volt)` Sets the output to a specific voltage **Parameters** - `$InstanceID` (int): Device ID - `$Volt` (float): Voltage to which the output is to be set **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. Voltage to which the output is to be set **Example** ```php //Sets the output voltage to 5.30 volts PJ_SetVoltage(12345, 5.30); ``` ## EKM-868 Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/ekm-868/ ### Description The power control module EKM 868 is a 4-channel module with 32-bit counter, which counts of four inputs and records their duration. The bidirectional data transmission takes place via a USB radio transceiver operating in the 868 MHz frequency band. It is used to visualize and projection of consumption costs in conjunction with IP Symcon. The count remains valid as long a power supply consists (9V = power adapter). A clear (reset) of the count by a power outage is detected by IP Symcon, a battery backup is therefore not required. The running PC you only need to provide a single value with a timestamp and to generate graphics. A special feature of the EKM 868 is that in addition the current power (consumption) is recorded. ### Installation To query counter data, first the virtual Comport driver on Windows must be installed and the USB radio transceiver must be connected. ### Configuration Now add a new EKM 868 (manufacturer: IP Symcon/ ProJet): ![EKM-868 Configuration](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/geraete/ips-868/ekm-868/1657454fe0-1790424938/ekm-868-konfiguration.png) | Value | Description | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | DeviceID | Default 128 is predetermined. When two EKM 868 are present in a system, in the device a jumpers can be set: the two lower pins (direction Header, upper PIN: NC). The new ID is then 129. ATTENTION: If red LEDs are installed (1 to 4), the ID is 129 by open Jumper! Devices with the ID 130/131, etc. are available on request. | | CounterID | The ID corresponds to the respective inputs (channels): 1,2,3,4 | | Modus: Read counter | It is read out the count (Variable: Counter) and the time interval in 1/100 seconds between two impulses (Current). | | Modus: Read on-time | The duty cycle (closed contact) is returned in 1/10 seconds (at 32 bits this results in a period of more than 13 years!) | | Modus: Read off-time | The off-time (contact open) is returned in 1/10 seconds | | Impulse | At electricity meters the impulses are entered per kWh. The unit of the variable "Current" is then also kWh. At 0 is the unit 1/100 second - ideal for e.g. to determine the volumetric flow of gas or water meter. | | Timer activated | With a set tick values ​​are queried in the specified time interval. This is limited to a minimum of 60 sec. | | Test Center | A command for output values ​​will be sent to the EMK. When properly installed, the variables in the object tree are updated accordingly. | > **Warning:** Attention: > The inputs are not galvanically isolated - they must not exceed 5V. At plan view, the common ground of the four inputs is the right connection. At every entrance, an RC element was installed: 1K to as pull-up and 100nF mass. A switching e.g. with a reed contact to ground causes a count. The power supply must not exceed = 12V. Higher voltages or reversed polarity lead to destruction of the device. Then, an external protective circuit (Z-diode, resistor) is to provide. ### Tips & Tricks * The internal timing (Current) has a resolution of 16-bit and 1/100 overclocking. This means it can be detected pulse sequences of a maximum length of 655 seconds (almost 11 minutes). In case of an overflow, an -0- is returned. * Internally, the following formula is used to convert the current power in watt: P = (3600 * 1000) / (Current / 100 * Impulses) [Watt] Where "Current", is the time between two pulses in 1/100 seconds * To display the current energy consumption (energy-light), in practice intervals of 20 minutes revealed to be optimal. * Power supply: Please be sure to use the supplied = 9V power supply - no "bell transformer" Internally, a low drop 3.3 V voltage transformer is installed. The input voltage ranges from 5.0 V = to = 10.0 V. The inner contact of the DC socket is the positive pole. * If the counter e.g. is erased by a power failure, so this is not relevant because IP Symcon detects it automatically and takes it into account when generating the graphics > **Note:** Problem: LED lights permanently > Solution: If necessary, swap the wires of the respective counter input (electronically) > or wait until the counter continues to rotate and releases the reed contact (mechanical). ### Technical data * Dimensions (without antenna): 70 * 70 * 25 mm * Weight: 100g * Power supply: 9V bis 12V DC / 100 mA / Connector: DC socket for hollow plug 2,1mm * 4 * S0 Inputs / 4 * 32-Bit counter (TTL – 5V) * maximum count frequency: 100 Hz * minimum pulse length: 20 msec (debounced internally for mechanical contacts) * Protection class: IP 20 * Radio module: 868MHz (PC radio interface: USB-T 868 is not included) ## PJ_RequestStatus Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/ekm-868/pj-requeststatus/ `bool PJ_RequestStatus(int $InstanceID)` Queries the current values ​​for the device with the ID __InstanceID__ and writes it to the appropriate state variables. [ **Parameters** - `$InstanceID` (int): ID of the device **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. ID of the device **Example** ```php PJ_RequestStatus(12345); //Query values ``` ## FD-868 Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/fd-868/ ### Function The radio display 868 is used to display text messages on a 2 x 16-character LC display. In addition, three LEDs and a buzzer can be switched. Optional is an IO box (relay board) with two outputs (10A/250V) and two inputs (TTL +5V) available. The bidirectional data transmission takes place via an USB radio transceiver operating in the 868 MHz frequency band. ### Installation The radio display 868 is used to display text messages on a 2 x 16-character LC display. In addition, three LEDs and a buzzer can be switched. Optional is an IO box (relay board) with two outputs (10A/250V) and two inputs (TTL +5V) available. The bidirectional data transmission takes place via an USB radio transceiver operating in the 868 MHz frequency band. ### Configuration The following properties can be changed as follows (not by command): hold left button on the display and switch the device on. Follow the further instructions on the screen. | Value | Description | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------- | | Device-Address | By default, the ID: 1 is set. If more displays are available in a system, a new ID will be awarded. | | Group-Address | Here all displays e.g. of the ground floor will be addressed together. This feature is not available in the first generation. | | Broadcast-Address | Fixed: 255 - all displays will be addressed together | | Key click | On/ Off | > **Warning:** Only one device with the same ID may be present in a radio network. > **Note:** Optional is an IO box (relay board) with two outputs (10A/250V) and two inputs (TTL +5V) available. RJ-11 socket assignment (Display): > 1 – Input 1 / TTL > 2 – GND > 3 – Output 1 / Open Collector > 4 – Output 2 / Open Collector > 5 – VCC /+5V > 6 – Input 2 / TTL > IO-BOX socket on the terminal of ‘Output 1′ ### Tips & Tricks Scripts for a menu control are available in our forums: [Link to the forum post](https://community.symcon.de/t/ips-funksystem-868/21115) > **Warning:** You can not turn off the key-click in the first generation. > It signaled to the operator that the command from the USB radio transceiver has been adopted (Acknowledgment). ## PJ_Backlight Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/fd-868/pj-backlight/ `bool PJ_Backlight(int $InstanceID, bool $Status)` turns the display backlight on or off **Parameters** - `$InstanceID` (int): ID of the device to be switched - `$Status` (bool): __TRUE__ for on, __FALSE__ for off **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. __TRUE__ for on, __FALSE__ for off **Example** ```php PJ_Backlight(12345, true); ``` ## PJ_Beep Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/fd-868/pj-beep/ `bool PJ_Beep(int $InstanceID, int $TenthsOfSeconds)` outputs an audio signal **Parameters** - `$InstanceID` (int): ID of the device to be switched - `$TenthsOfSeconds` (int): Length of the tone in 1/10 seconds **Returns** (bool): default Length of the tone in 1/10 seconds **Example** ```php PJ_Beep($id_lcd, 50); // Beep for 0,5 seconds ``` ## PJ_LCDText Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/fd-868/pj-lcdtext/ `bool PJ_LCDText(int $InstanceID, int $Line, string $Text)` sends a text to the display **Parameters** - `$InstanceID` (int): ID of the device to be switched - `$Line` (int): Line number of the display (1 or 2) - `$Text` (string): Lines of text, 16 characters maximum - the rest is cut off **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. Lines of text, 16 characters maximum - the rest is cut off **Example** ```php PJ_LCDText($id_lcd, 1, "ALARM - Meldung"); // Return text in line 1 ``` ## PJ_SwitchLED Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/fd-868/pj-switchled/ `bool PJ_SwitchLED(int $InstanceID, int $LED, bool $Status)` switches an LED of the display **Parameters** - `$InstanceID` (int): ID of the device to be switched - `$LED` (int): 1 - `$Status` (bool): True = On / False = Off **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. True = On / False = Off **Example** ```php PJ_SwitchLED($id_lcd,1,False); // Red PJ_SwitchLED($id_lcd,3,True); // Green ``` ## PJ_SwitchMode Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/fd-868/pj-switchmode/ `bool PJ_SwitchMode(int $InstanceID, bool $Status)` switches an FS20 device on/off **Parameters** - `$InstanceID` (int): ID of the Relay to be switched - `$Status` (bool): __TRUE__ for On, __FALSE__ for Off **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. __TRUE__ for On, __FALSE__ for Off **Example** ```php PJ_SwitchMode($id_lcd, True); //Turn on Relay ``` ## Device list Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/device-list/ ### Supported Gateways | Gateway | | Description | | ---------------- | ------------------------------------------------------------------------------ | ------------------------------ | | Symcon LAN-T 868 | [Product Information](https://www.symcon.de/assets/files/product/ips-868-lan-gateway.pdf) | IP gateway with LAN connection | | Symcon USB-T 868 | | USB gateway with USB port | ### Supported Components | Components | | Description | | -------------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------- | | [AKM-868](ips-868.md) | [Product Information](https://www.symcon.de/assets/files/product/ips-868-akm.pdf) | AttendanceControlModule | | [EKM-868](ips-868.md) | [Product Information](https://www.symcon.de/assets/files/product/ips-868-ekm.pdf) | EnergyControlModule (4-channel meter module) | | [FD-868](ips-868.md) | | Wireless display | | [JKM-868 LevelJet](ips-868.md) | | LevelJET | | [JKM-868 ThermoJET](ips-868.md) | | ThermoJET | | [LGS-868](ips-868.md) | [Product Information](https://www.symcon.de/assets/files/product/ips-868-lgs.pdf) | AirQualitySensor | | [RGBW-868](ips-868.md) | [Product Information](https://www.symcon.de/assets/files/product/ips-868-rgbw.pdf) | LED stripe controller (12V/24V) | | [SERVO-868](ips-868.md) | | 4-way servo controller | | Tracker 868 | [Product Information](https://www.symcon.de/assets/files/product/ips-868-akm.pdf) | Key fob (used in combination with the AKM-868) | | [WDT-868](ips-868.md) | | Watch-Dog-Timer | ## JKM-868 LevelJET Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/jkm-868-leveljet/ ### Description The JKM-868 with connected LevelJET is used to read out the individual values of the LevelJET level indicator. ### Installation In order to be able to receive data, the virtual COM port driver from Silicon Labs (CP210x) must first be installed on Windows and the USB-T 868 radio transceiver must be connected. In IP-Symcon, “JKM-868 (LevelJET)” must be added. The parent instances (e.g. the gateway) are created automatically. Alternatively, the 868 LAN gateway can also be used. A client socket with the appropriate settings must be selected as the “parent instance”. ### Configuration The DeviceID defaults to 166 and must be added to the address of the respective device. Example: the LevelJET has the address 12 - so 178 must be entered here. The address is parameterized in LevelJET according to the manufacturer's instructions. | Variable | Description | | ---------- | ---------------------- | | Distance | Distance in cm | | Output (1) | State of the 1st Relay | | Output (2) | State of the 2nd Relay | ![Level 1](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/geraete/ips-868/jkm-868-leveljet/1e687be738-1790424938/jkm-level1.png) > **Warning:** The distance value (input) is queried cyclically in the set “interval”. The status of both outputs cannot be actively queried. It is sent automatically after the distance thresholds set in the LevelJET have been exceeded or undershot. ### Tips & Tricks In order to calculate the volume in liters, own PHP scripts must be created. ## PJ_RequestStatus Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/jkm-868-leveljet/pj-requeststatus/ `bool PJ_RequestStatus(int $InstanceID)` Query the status of variables and set them **Parameters** - `$InstanceID` (int): Device ID **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. Device ID **Example** ```php //Queries the current values of instance 12345. PJ_RequestStatus(12345); ``` ## JKM-868 ThermoJET Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/jkm-868-thermojet/ ### Description The JKM-868 with attached ThermoJET is used to read out the individual values of the ThermoJET temperature controller. ### Installation In order to be able to receive data, the virtual COM port driver from Silicon Labs (CP210x) must first be installed on Windows and the USB-T 868 radio transceiver must be connected. In IP-Symcon, “JKM-868 (ThermoJET)” must be added. The parent instances (e.g. the gateway) are created automatically. Alternatively, the 868 LAN gateway can also be used. A “client socket” with the appropriate settings must be selected as the “parent instance”. ### Configuration The DeviceID defaults to 166 and must be added to the address of the respective device. Example: The ThermoJET has the address 17 - so 183 must be entered here. The ThermoJET has 8 inputs - if more than 4 temperature guides are connected, every second JKM instance with the mode setting: “Input (5-8)” must be added to IP-Symcon. | Variable | Description | | ------------------ | ----------------------- | | Output (1) | State of the 1st Relay | | Output (2) | State of the 2nd Relay | | Temperature (1..4) | Temperature value in °C | > **Warning:** Note: If no sensor is connected, the output is -99.9°C > **Note:** If a second instance is created for input 5-8, the new variables are still called temperature 1-4. These can be renamed if required. The variables for outputs 1+2 are the same in both modes. ![Thermo 1](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/geraete/ips-868/jkm-868-thermojet/96a2dcb639-1790424938/jkm-thermo1.png) > **Warning:** The four temperature channels (inputs) are queried cyclically in the set “interval”. The status of both outputs cannot be actively queried. This is sent automatically after the temperature thresholds set in the ThermoJET have been exceeded or undershot. ## PJ_RequestStatus Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/jkm-868-thermojet/pj-requeststatus/ `bool PJ_RequestStatus(int $InstanceID)` Query the status of variables and set them **Parameters** - `$InstanceID` (int): Device ID **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. Device ID **Example** ```php //Queries the current values of instance 12345. PJ_RequestStatus(12345); ``` ## LGS-868 Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/lgs-868/ The air quality sensor (LGS-868) analyses room air and summarizes the concentration of mixed gases in the air into a usable value (ppm - parts per million). > **Note:** Technical information and advice on proper ventilation can be found in the following brochure: [Download](https://www.symcon.de/assets/files/product/IPS-868-lgs-ds.pdf) ### Installation In order to receive data, an IPS-868 gateway (LAN or USB) must first be connected and set up. The parent instances (e.g. the gateway) are created automatically. ### Configuration To use the device in IP-Symcon, a new LGS-868 instance (manufacturer: IP-SymCon/ ProJet) must be added. If parent instances do not yet exist, they are created automatically. | Value | Description | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Device address | The ID:176 is specified by default. If several controllers exist in a system, a new ID must be assigned. The jumper configuration can be found in the operating instructions. | > **Warning:** Only one device with the same ID may be present in one wireless network at a time. ### Application The device returns an integer value that returns the measured ppm (parts per million/ millionth share). The official limits can be found in the table below. The LGS-868 has 3 LEDs (green/yellow/red), which are automatically switched at the IP-Symcon limit values (450-1000/ 1001-1500/ 1501-2100). The automatic can be switched off by setting “Limit (yellow)” and “Limit (red)” to 0 in the configuration page. | ppm | Air quality | | ------------ | ---------------------------------------------------------- | | >2100 | Very bad (heavily polluted room air; ventilation required) | | 2100... 1501 | Bad (heavily polluted room air; ventilation required) | | 1500... 1001 | Medium (polluted room air; ventilation recommended) | | 1000... 801 | Satisfactory | | 800... 601 | Good | | 600... 450 | Excellent | > **Note:** Extremely high values above 2100 ppm are rare and are based, for example, on possible alcohols in cleaning products or typical odors in a restroom. ## PJ_RequestStatus Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/lgs-868/pj-requeststatus/ `bool PJ_RequestStatus(int $InstanceID)` Query the status of variables and set them **Parameters** - `$InstanceID` (int): Device ID **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. Device ID **Example** ```php //Queries the current values of instance 12345. PJ_RequestStatus(12345); ``` ## PJ_SetLEDs Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/lgs-868/pj-setleds/ `bool PJ_SetLEDs(int $InstanceID, bool $Green, bool $Yellow, bool $Red)` switches LEDs on the AirQualitySensor **Parameters** - `$InstanceID` (int): ID of the device to be switched - `$Green` (bool): Turns off the green LED - `$Yellow` (bool): Turns off the yellow LED - `$Red` (bool): Turns off the red LED **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. Turns off the red LED **Example** ```php //Turns the green and yellow LED on and the red LED off. PJ_SetLEDs(12345,true,true,false); ``` ## RGBW-868 Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/rgbw-868/ > **Note:** [Manual as a PDF](http://projet.de/Datasheets/RGBW868_24V.pdf) ### Description The LED stripe controller is used to control LED stripes to allow different lighting scenarios and moods in a residential environment. ### Installation To communicate with the controller, you must first install the virtual comport driver and connect the USB radio transceiver. In IP Symcon 'RGBW(Stripe)' must be added. The parent instances (e.g. the gateway) are automatically created. Please check if the right COM-Port was selected. ### Configuration | Value | Description | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Device-Address | By default, the ID: 144 is given. If more controllers are present in a system, a new ID will be awarded. Please check the jumper assignment in the instruction manual. Note: If necessary, the addresses: 149,150 and 151 are occupied by the system | | Broadcast-Address | Fixed: 254 - all controller will be addressed together | > **Warning:** Only one device with the same ID may be present in a radio network. ### A first test For a quick check of basic functionality click the right mouse button on the 'RGBW(Stripe)' module, then 'Open Object' (or double-click) and choose a color, or, if connected, a brightness value for white-channel. Then click 'Insert'. The LED will light stripe in the desired color. ![RGBW-Configuration](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/geraete/ips-868/rgbw-868/8d7af4b91c-1790424938/rgbw-konfiguration.png) ### Check in case of problems * When switching on the 12V supply the LED stripe flashes briefly. * The red LED on the board is also lit up brightly and then flashes further (very) slightly. * All jumpers open means address 144. * If commands are received, the LED lights as well. * If commands are sent, the Rx/Tx LED lights on the USB-T * The splitter 'ProJet Gateway' must be connected to the correct COM-Port ### Tips & Tricks In addition to the lighting scenes also for example flashing warning or flashing notes can be dislayed. These can be acknowledged by both of the controller pushbutton inputs as positive (as YES) or negative (as NO) since the used radio system is bidirectional. In IP Symcon the 'FD(Stripe) Input' module has to be added. ## PJ_DimRGBW Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/rgbw-868/pj-dimrgbw/ `bool PJ_DimRGBW(int $InstanceID, int $R, int $RTime, int $G, int $GZeit, int $B, int $BZeit, int $W, int $WZeit)` **Parameters** - `$InstanceID` (int): ID of the device to be switched - `$R` (int): Brightness value 0 (off) to 255 (on, maximum brightness) - `$RTime` (int): In seconds in which the desired brightness level is to be achieved - `$G` (int): Brightness value 0 (off) to 255 (on, maximum brightness) - `$GZeit` (int): In seconds in which the desired brightness level is to be achieved - `$B` (int): Brightness value 0 (off) to 255 (on, maximum brightness) - `$BZeit` (int): In seconds in which the desired brightness level is to be achieved - `$W` (int): Brightness value 0 (off) to 255 (on, maximum brightness) - `$WZeit` (int): In seconds in which the desired brightness level is to be achieved **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. In seconds in which the desired brightness level is to be achieved **Example** ```php //dim in 2 seconds on yellow PJ_DimRGBW(12345,255,2,255,2,0,0,0,0); ``` ## PJ_RunProgram Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/rgbw-868/pj-runprogram/ `bool PJ_RunProgram(int $InstanceID, int $Program)` **Parameters** - `$InstanceID` (int): ID of the device to be switched - `$Program` (int): 0 – all RGBW off; 1 – all RGBW at the last brightness value; 2- blink slowly; 3- blink rapidly; 4- flash slowly ; 5- flash rapidly; 6- fade slowly **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. 0 – all RGBW off; 1 – all RGBW at the last brightness value; 2- blink slowly; 3- blink rapidly; 4- flash slowly ; 5- flash rapidly; 6- fade slowly **Example** ```php //let LEDs blink rapidly PJ_RunProgram(12345, 3); ``` ## PJ_SetRGBW Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/rgbw-868/pj-setrgbw/ `bool PJ_SetRGBW(int $InstanceID, int $R, int $G, int $B, int $W)` sets a color value **Parameters** - `$InstanceID` (int): ID of the device to be switched - `$R` (int): Brightness value 0 (off) to 255 (on, maximum brightness) - `$G` (int): Brightness value 0 (off) to 255 (on, maximum brightness) - `$B` (int): Brightness value 0 (off) to 255 (on, maximum brightness) - `$W` (int): Overall brightness value 0 (off) to 255 (on, maximum brightness) **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. Overall brightness value 0 (off) to 255 (on, maximum brightness) **Example** ```php // Switch to yellow at full brightness PJ_SetRGBW(12345,255,255,0,255); ``` ## SERVO-868 Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/servo-868/ ### Description The 4-way servo controller is used to control commercially available model-making servos with the RJ connector system. As a second function, up to four buttons can be connected as control inputs. ### Installation In order to communicate with the controller, the USBT-868 or LAN-T-868 gateway must have been installed beforehand. The instance "Servo-868" must be added in IP-Symcon. The parent instances such as the "ProJetGateway" are created automatically. It must be checked whether the correct virtual COM port was selected by the USB gateway. With the LAN-T-868 Gateway, the correct IP address and port must be specified in the "Client Socket". ### Configuration The default device address is ID:160. If there are more controllers in a system, a new ID must be assigned. The jumper configuration can be found in the operating instructions. ### A first test For a quick first function test, the device must be connected to a suitable power source. It is important to pay attention to the correct polarity. A servo is then connected to the servo output with a flat cable and a plug with a contact spacing of 2.54 mm. As a rule, the brown wire is "minus", red is "plus" and orange is the "PWM" signal. In IP-Symcon, the configuration page can be opened by right-clicking (or double-clicking) on the "Servo-868" instance and then on "Open object". A value between 0 and 255 can be entered in the respective "Channel" in the 'Test Environment'. After "Set Channel n" the servo moves to a new position. ### Tipps & Tricks [https://en.wikipedia.org/wiki/Servo_(radio_control)](https://en.wikipedia.org/wiki/Servo_(radio_control)) [https://www.mikrocontroller.net/articles/Modellbauservo_Ansteuerung](https://www.mikrocontroller.net/articles/Modellbauservo_Ansteuerung) [http://www.electronicsplanet.ch/Roboter/Servo/intern/intern.htm](http://www.electronicsplanet.ch/Roboter/Servo/intern/intern.htm) ## PJ_DimServo Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/servo-868/pj-dimservo/ `bool PJ_DimServo(int $InstanceID, int $Channel, int $Value, int $Steps)` incrementally sets a servo value **Parameters** - `$InstanceID` (int): ID of the device to be switched - `$Channel` (int): Servo channel 1..4 - `$Value` (int): Value from 0..255 - `$Steps` (int): Steps from 0 (instant) through 1 (slow) to 255 (fast) **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. Steps from 0 (instant) through 1 (slow) to 255 (fast) **Example** ```php // Immediately sets servo channel 1 to the value 255 PJ_DimServo(12345, 1, 255, 0); ``` ## PJ_SetServo Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/servo-868/pj-setservo/ `bool PJ_SetServo(int $InstanceID, int $Channel, int $Value)` **Parameters** - `$InstanceID` (int): ID of the device to be switched - `$Channel` (int): Servo channel 1..4 - `$Value` (int): Value from 0..255 **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. Value from 0..255 **Example** ```php PJ_SetServo(12345, 1, 255); ``` ## WDT-868 Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/wdt-868/ ### Description The watchdog timer is used to monitor computer systems and individual programs. A "sign of life" is sent cyclic from the PC to the WDT. If this is not received correctly, can via a potential free contact e.g. a siren ca be activated or a hardware reset can be executed. Additionally, the UM-relay (5A/230V) can be turned on and off, or to be addressed by a timer (65,535 sec). The unit also has a pushbutton input at leisure. The status is shown as a variable in IP Symcon. ### Installation To receive data, previously on Windows must be the [virtual comport driver from Silicon Labs (CP210x)] installed[1] and the T-USB 868 radio transceiver connected. In IP Symcon 'WDT-868' must be added. The parent instances (e.g. the gateway) are automatically created. ### Configuration In the DeviceID 165 will be set (Position 0). This can be changed by turning the coding switch to 174 (Position 9). ![WDT-Tree](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/geraete/ips-868/wdt-868/eae823a029-1790424938/wdt-tree.png) | Variable | Description | | -------- | --------------------------------------------------- | | Input | False: Button is open / True: Button is pressed | | Status | False: Relay de-energized / True: Relay energized | | Timer | Time in seconds, after the relay changes its status | After the timer expires, the WDT sends the new state of the relay. The state variable is updated accordingly (no simulation). By an active timer the LED blinks every second. A brief flash signals a radio commands in IP Symcon-868 radio system[/i] > **Warning:** Only one device with the same ID may be present in a radio network. ### Tipps & Tricks To the two contacts of the switch e.g. an external switch (doorbell, motion sensors, photocells, etc.) can be connected. ## PJ_SwitchDuration Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/wdt-868/pj-switchduration/ `bool PJ_SwitchDuration(int $InstanceID, bool $Status, int $Dauer)` **Parameters** - `$InstanceID` (int): ID of the device to be switched - `$Status` (bool): __TRUE__ for On, __FALSE__ for Off - `$Dauer` (int): On or off times in seconds **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. On or off times in seconds **Example** ```php //The following command turns on the relay for 60 seconds: PJ_SwitchDuration(12345, True, 60); ``` ## PJ_SwitchMode Source: https://www.symcon.de/en/service/documentation/module-reference/devices/ips-868/wdt-868/pj-switchmode/ `bool PJ_SwitchMode(int $InstanceID, bool $Status)` **Parameters** - `$InstanceID` (int): ID of the device to be switched - `$Status` (bool): __TRUE__ for On, __FALSE__ for Off **Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__. __TRUE__ for On, __FALSE__ for Off **Example** ```php PJ_SwitchMode(12345, True); ```