Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revisionBoth sides next revision | ||
system_objs [2019/09/09 11:29] – [Lutron] ingrid | system_objs [2020/07/15 09:30] – [System Objects] ingrid | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== System Objects ====== | ====== System Objects ====== | ||
+ | <WRAP group> | ||
+ | <WRAP column half> | ||
+ | * [[#System| System]] | ||
+ | * [[#ets| ETS]] | ||
+ | *[[# | ||
+ | * [[# | ||
+ | * [[#scene| Scene]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#RGB| RGB]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#web_ui| Web UI]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#Logic| Logic]] | ||
+ | * [[# | ||
+ | * [[#filter| Filter]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | </ | ||
+ | <WRAP column half> | ||
- | ===== System | + | * [[# |
+ | * [[#Report| Report]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#Lutron| Lutron Project]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#tester| Tester]] | ||
+ | |||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[#display| Display]] | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | </ | ||
+ | </ | ||
+ | ====== System | ||
{{ : | {{ : | ||
Line 19: | Line 85: | ||
* **Server client port** Number of the TCP port needed to remotely connect with the server (outside the server network). The default port is 7550. | * **Server client port** Number of the TCP port needed to remotely connect with the server (outside the server network). The default port is 7550. | ||
* **Local IP address** IP address (for example 192.168.X.X) needed to connect with the server from clients that operate in the server LAN. | * **Local IP address** IP address (for example 192.168.X.X) needed to connect with the server from clients that operate in the server LAN. | ||
+ | * **KNXNet/IP interface** if enabled, the Thinknx server can be used as a KNXNet/IP interface, allowing KNX programming from the ETS software for example. More information are available on the [[knxnet_ip| KNXnet/IP]] guide. | ||
+ | * **KNXNet/IP different IP** if enabled, permits to choose a different KNXNet/IP interface to connect and access the KNX bus. | ||
+ | * **Clients Ph. Address Base** base physical address for the clients connections. | ||
+ | * **Client number** number of supported client tunnel connections. | ||
+ | * **KNXNet/IP router** If enabled, the server will also route traffic from TP to multicast IP and vice versa, allowing to connect different parts of a KNX system together over IP. More information are available on the [[knxnet_ip| KNXnet/IP]] guide. | ||
* **System name** Name to identify the project once it has been uploaded to the server. | * **System name** Name to identify the project once it has been uploaded to the server. | ||
* **Location** Name of the location where the system is installed. | * **Location** Name of the location where the system is installed. | ||
Line 32: | Line 103: | ||
* **Users and Groups** Groups and users for the customized exporting process, for more details refer to [[main_cons_ui# | * **Users and Groups** Groups and users for the customized exporting process, for more details refer to [[main_cons_ui# | ||
* **Protection PINs** List of PINs used to protect interface objects, for more details refer to [[main_cons_ui# | * **Protection PINs** List of PINs used to protect interface objects, for more details refer to [[main_cons_ui# | ||
- | ==== Object commands ==== | ||
+ | ==== Object Commands ==== | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
+ | ++++Send KNX Bit telegram| | ||
+ | * **KNX Group** Group address to sen the value. | ||
+ | * **KNX value** Can be either 1 or 0. | ||
- | == Send KNX Bit telegram: == | + | ++++ |
- | + | ++++Send KNX Byte Telegram| | |
- | This command is used to send a bit value; adjust | + | * **KNX Group** Group address to send the value. |
- | + | * **KNX value** Can be a value between 0-255. | |
- | == Send KNX Byte Telegram: == | + | A generic button can be configured to send a fixed dimming |
- | + | ++++ | |
- | Send a byte value; adjust | + | ++++Send KNX Float 2 Byte Telegram| This command is used to send a 2 byte float value to the KNX bus. |
- | + | * **KNX Group** Group address to send the value. | |
- | == Send KNX Float 2 Byte Telegram: == | + | * **KNX value** Can be a value between -671088,64 and 670760,96. |
- | + | A generic button can be configured to send a fixed temperature value to a thermostat, for example sending the value 21.5 as a setpoint. | |
- | Send a float 2 byte value; adjust | + | ++++ |
- | + | ++++Send KNX Float 4 Byte Telegram| This command is used to send a 4 byte float value to the KNX bus. | |
- | == Send KNX Float 4 Byte Telegram: == | + | * **KNX Group** Group address to send the value. |
- | + | * **KNX value** | |
- | Send a float 4 byte value; adjust | + | ++++ |
- | + | ++++Send KNX String Telegram| This command is used to send a string of 14 bytes to the KNX bus. | |
- | == Send KNX String Telegram: == | + | * **KNX Group** Group address to send the value. |
- | + | * **KNX value** string text to be entered. | |
- | Send a string 14 byte value; adjust | + | ++++ |
- | + | ++++Send KNX 4 Bit Telegram| | |
- | == Make a pause for a fixed interval | + | * **KNX Group** Group address to send the value. |
- | + | * **KNX value** Can be a value between 0 and 15. | |
- | Pause the system for a specified time interval configurable | + | A generic button can be configured to decrease (value 0-7) or increase ( value 8-15) a light dimming value. It can also be used to change a shutter position (use values 0-7 for UP, and 8-15 for DOWN). For example, sending the value 5 to a dimmer will decrease the brightness by 6%, while sending the value 10 to a shutter will lower its position by 50%. |
- | + | ++++ | |
- | == Change UI Function and Page: GENERAL | + | ++++Read |
- | + | * **KNX Group** Group address to read the value from. | |
- | This command allows to configure | + | ++++ |
- | + | ++++Make a pause for a fixed interval| This command pauses | |
- | == Change UI Function and Page: SPECIFIC CLIENT | + | * **Interval** Time interval in milliseconds. |
- | + | When saving a scene, sometimes a pause between two commands is necessary, for example, when saving the TV channel number. Another use of the Pause application would be before turning off the final light in a Goodbye scene, making sure that the client has left the house. | |
- | This command allows to configure | + | ++++ |
- | + | ++++Change UI Function and Page: GENERAL| This command allows to redirect **all clients** to a specific | |
- | == Send Push Notification | + | * **Function** insert the Index number of the destination function. |
- | + | * **Page** insert the Index number of the destination page. | |
- | This command allows to send push notifications on the desired | + | Using the Universal Gateway, a scenario can be configured to redirect the users to the Main Entrance camera page whenever the doorbell rings. |
- | + | ++++ | |
- | == Execute MS Windows Command: GENERAL | + | ++++Change UI Function and Page: SPECIFIC CLIENT| This command allows |
- | + | * **Function** insert the Index number of the destination function. | |
- | This command allows to launch an .exe file directly from the ThinKnx application on all Players for Windows; adjust the ”Command” parameter. | + | * **Page** insert the Index number of the destination page. |
- | + | Invisible generic buttons can be placed | |
- | == Execute MS Windows Command: SPECIFIC CLIENT | + | ++++ |
- | + | ++++Send Push Notification| This command allows to send push notifications | |
- | This command allows to launch an .exe file directly from the ThinKnx application on a specific Player | + | * **Message** insert the message to be displayed on the clients. |
- | + | * **Maximum number of push notifications with the same identifier allowed in 10 min** This parameter | |
- | == Recall iOS app with url == | + | * **Push Notification Identifier** A small descriptive text to allow the system to differentiate a push notification |
- | + | Using the Universal Gateway, a push notification can be sent to the client when a 1-bit value is received from the bus to indicate that the Water Tank Level is low. The message in that case can be "Low Water Level!" | |
- | This property allows to launch a specific | + | <WRAP important round center 60%>Push notifications only work with internet connectivity. In addition, the server and client should both have the same version of Thinknx software (both Classic or Thinknx UP).</ |
- | + | ++++ | |
- | == Send Email to recipients | + | ++++Execute MS Windows Command: GENERAL| This command allows to launch an .exe file directly from the ThinKnx application on all Players for Windows. |
- | + | * **Command** | |
- | This command allows to send an email message using a default ThinKnx account; define | + | * **Parameter** |
- | + | ++++ | |
- | == Send DTMF tone during intercom call == | + | ++++Execute MS Windows Command: SPECIFIC CLIENT| This command allows to launch an .exe file directly from the ThinKnx application on all Players |
+ | * **Command** | ||
+ | * **Parameter** | ||
+ | ++++ | ||
+ | ++++Recall iOS app with url| This property allows to launch a specific | ||
+ | * **URL used to recall iOS app** Type in the correct URL to open the desired installed application, | ||
+ | A generic button can be configured for the client to open another application on the iOS device. | ||
+ | ++++ | ||
+ | ++++Send Email to recipients| This command allows to send an email message using a default ThinKnx account. | ||
+ | * **Email Subject** Enter the email title here. | ||
+ | * **Email Recipients** Enter destination email accounts. | ||
+ | * **Email Content** Enter the email content | ||
+ | If the client' | ||
- | This command allows to send a DTMF tone or a sequence of tones while an intercom call is running on the client. | + | <wrap important>// |
+ | ++++ | ||
+ | ++++Send DTMF tone during intercom call| This command allows to send a DTMF tone used in telephony | ||
+ | * **DTMF tones sequence** enter the sequence of numbers to send during the intercom call. Sometimes it is necessary to end the sequence with the symbol "#", | ||
+ | A generic button can be configured in the Intercom page to send a DTMF tone to open the main gate whenever a call is established. | ||
+ | ++++ | ||
+ | ++++Make SIP call| When using the Thinknx server as PBX, it is possible to make internal calls between all the devices. | ||
+ | * **Extension to call** Enter the extension of the destination device. | ||
+ | A house owner can have a generic button on his application to call the extension of the touch screen installed in Kitchen to communication with the help. | ||
+ | ++++ | ||
+ | ++++Start audio notification sound in all the clients| This command allows to play an audio sound in all the clients. | ||
+ | * **Sound to play** Choose between different beeps to play: 0=Beep_1, 1=Beep_2, 2=Alarm_1, 3==Alarm_2, 4=Siren_1, 5=Siren_2. | ||
+ | * **Duration of the sound to play** Specify the duration of the sound to play in seconds. If 0 is entered, the sound will play endlessly until a Stop command has been sent. | ||
+ | An emergency push button can be installed in bathrooms to send a KNX 1-bit value. Using the Universal Gateway, this value received can launch the command to start audio notification on all clients. | ||
+ | ++++ | ||
+ | ++++Stop audio notification sound in all clients| This command allows to stop the audio sound previously launched in all clients. | ||
+ | \\ See above command for example. | ||
+ | ++++ | ||
+ | ====== ETS ====== | ||
===== ETS project ===== | ===== ETS project ===== | ||
Line 114: | Line 218: | ||
From the ETS application, | From the ETS application, | ||
+ | |||
+ | |||
+ | |||
+ | ====== Internal Services ====== | ||
===== Scene ===== | ===== Scene ===== | ||
Line 129: | Line 237: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
+ | ++++Launch scenery| | ||
+ | ++++ | ||
+ | ++++Sop scenery execution| | ||
+ | ++++ | ||
- | == Launch scenery == | ||
- | |||
- | Launches the selected scene. | ||
- | |||
- | == Stop scenery execution == | ||
- | |||
- | Stops the selected scene. | ||
- | |||
- | ===== Calendar ===== | ||
- | |||
- | {{ : | ||
- | |||
- | This server service allows the user to program on/off KNX commands (switch objects) using client applications; | ||
- | |||
- | * **Force state** If this property is enabled, the server periodically sends value ”1” to the selected KNX group, basing on the pre-set timespan; the light automatically turns on if it has been manually switched off by the user. If enabled, the ”Send interval” property will be displayed: | ||
- | * [//Send interval//] Interval between two repeated messages | ||
===== HVAC Controller ===== | ===== HVAC Controller ===== | ||
Line 154: | Line 250: | ||
* **Controller type** Selection among three possible models: | * **Controller type** Selection among three possible models: | ||
- | * // | + | * //**Mitsubishi AG 150:**// This controller permits to interact with Mitsubishi G50, AG150 and newer controllers with Mitsubishi XML protocol (this protocol needs to be enabled on the Mitsubishi side). |
- | * //KNX interface simple:// This controller allows to set mode and speed using standard 1 byte objects. | + | * //**KNX interface simple:**// This controller allows to set mode and speed using standard 1 byte objects. |
- | * //KNX interface extended:// This controller allows to set mode and speed using 1 bit objects.\\ | + | * //**KNX interface extended:**// This controller allows to set mode and speed using 1 bit objects.\\ |
+ | * // | ||
- | If Controller type is ”Mitsubishi AG 150” the following | + | Select the ”Devices” property |
- | * **IP address** HVAC controller | + | |
+ | ==== CoolMaster Net ==== | ||
+ | |||
+ | CoolAutomation devices permits to directly talk with many Air conditioning brands including Daikin and many others. It is connected directly to the AC bus and can control with a single interface all the units connected to the bus. | ||
+ | |||
+ | Integration with Thinknx is directly through the network and permits to control devices under CoolMaster directly within Thinknx. It is not required that the CoolMaster has KNX port. The communication with the KNX devices | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | On the system node the following properties will appear:\\ | ||
+ | * **IP address** HVAC Controller | ||
+ | * **Port number** TCP/IP port for Ethernet connection. For example, 10102. | ||
* **Devices** List of HVAC devices linked to the system. | * **Devices** List of HVAC devices linked to the system. | ||
- | ==== Adding a HVAC device | + | These are the properties for the single |
+ | * // | ||
+ | * // | ||
+ | * //**KNX On/Off command group**// 1-bit group to switch the device on/off from KNX | ||
+ | * //**KNX On/Off feedback group**// 1-bit group to receive feedback regarding on/off status of the device | ||
+ | * //**KNX Fan command group:**// 1-byte group to switch device fan speed from KNX. | ||
+ | * //**KNX Fan feedback group:**// 1-byte group to receive feedback regarding fan speed status of the device | ||
+ | * //**KNX Temperature setpoint command group**// 2-byte DPT9 group to set the setpoint temperature for the device from KNX | ||
+ | * //**KNX Temperature setpoint feedback group**// 2-byte DPT9 group to receive feedback regarding actual setpoint from the device. | ||
+ | * //**KNX Mode command group:**// 1-byte group to switch device modality from KNX. | ||
+ | * //**KNX Mode feedback group:**// 1-byte group to receive feedback regarding modality of the device. | ||
+ | * //**Actual temperature from internal unit KNX group**// 2-byte DPT9 group to receive actual temperature read from the device (only available if supported by the device) | ||
+ | * //**Value fan min:**// value for minimum fan speed. It will be sent to fan command group to set speed and, if received in fan feedback group, minimum speed will be recognized (1-byte value). | ||
+ | * //**value fan middle:**// value for middle fan speed. It will be sent to fan command group to set speed and, if received in fan feedback group, middle speed will be recognized (1-byte value). | ||
+ | * //**value fan max:**// value for maximum fan speed. It will be sent to fan command group to set speed and, if received in fan feedback group, maximum speed will be recognized (1-byte value). | ||
+ | * //**Value Cool Mode:**// value that corresponds to Cool Modality for mode group (1-byte). | ||
+ | * //**Value Heat Mode:**// value that corresponds to Heat Modality for mode group (1-byte). | ||
+ | * //**Value Dry Mode:**// value that corresponds to Dry Modality for mode group (1-byte). | ||
+ | * //**Value Fan Mode:**// value that corresponds to Fan Modality for mode group (1-byte). | ||
+ | * //**Enable regulator: | ||
- | Select the ”Devices” property and click on the button displayed on the right to open the devices editor window; click on ”Add” button and adjust the properties in the grid. | ||
==== Mitsubishi device ==== | ==== Mitsubishi device ==== | ||
+ | If Controller type is ”// | ||
+ | * **IP address** HVAC controller IP address.\\ | ||
+ | |||
+ | These are the properties for the single device: | ||
* **Name** Device name. | * **Name** Device name. | ||
* **Device index** Index associated to the device inside the controller. | * **Device index** Index associated to the device inside the controller. | ||
Line 260: | Line 390: | ||
* **Force state** If this property is enabled, the server periodically sends value ”1” to the selected KNX group, basing on the pre-set timespan; the light automatically turns on if it has been manually switched off by the user. If enabled, the ”Send interval” property will be displayed: | * **Force state** If this property is enabled, the server periodically sends value ”1” to the selected KNX group, basing on the pre-set timespan; the light automatically turns on if it has been manually switched off by the user. If enabled, the ”Send interval” property will be displayed: | ||
* //Send interval//: Interval between two repeated messages | * //Send interval//: Interval between two repeated messages | ||
+ | |||
+ | ===== Calendar (obsolete) ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | This server service allows the user to program on/off KNX commands (switch objects) using client applications; | ||
+ | |||
+ | * **Force state** If this property is enabled, the server periodically sends value ”1” to the selected KNX group, basing on the pre-set timespan; the light automatically turns on if it has been manually switched off by the user. If enabled, the ”Send interval” property will be displayed: | ||
+ | * [//Send interval//] Interval between two repeated messages | ||
+ | |||
+ | |||
+ | ===== Voip PBX and Doorcom ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | Every Thinknx server embeds a software VOIP telephony PBX. It is optimized for the VOIP functionalities between clients and door communication. This system object allows to configure the PBX (extensions, | ||
===== Chronotermostat ===== | ===== Chronotermostat ===== | ||
Line 280: | Line 426: | ||
* **Mode feedback group** KNX group (1 bit DPT1) used to send the running chrono modality where 1=chrono and 0=manual. | * **Mode feedback group** KNX group (1 bit DPT1) used to send the running chrono modality where 1=chrono and 0=manual. | ||
- | + | ==== Object commands | |
- | ===== Voip PBX & Doorcom ===== | + | Commands sent to the object and recallable from other objects: |
- | + | ++++Enable/ | |
- | {{ :system_obj_-_voip.png? | + | * **Enable/ |
- | + | ++++ | |
- | Every Thinknx server embeds a software VOIP telephony PBX. It is optimized for the VOIP functionalities between clients and door communication. | + | |
===== Irrigation ===== | ===== Irrigation ===== | ||
Line 312: | Line 456: | ||
* **KNX feedback group** KNX group address used to detect the status of the zone (DPT1 - 1 = irrigating, 0 = pause). | * **KNX feedback group** KNX group address used to detect the status of the zone (DPT1 - 1 = irrigating, 0 = pause). | ||
+ | ==== Object commands ==== | ||
+ | Commands sent to the object and recallable from other objects: | ||
+ | ++++Enable/ | ||
+ | ++++ | ||
===== RGB ===== | ===== RGB ===== | ||
Line 348: | Line 496: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Start RGB sequence shuffle with time in seconds | + | ++++Start RGB sequence shuffle with time in seconds| This command allows to play a sequence of all the favorite colors in a shuffle mode, while defining the time to switch from one color to another. |
+ | * **Time** interval before switching to a new color, in seconds | ||
+ | ++++ | ||
- | Starts the preconfigured colour | + | ++++Start RGB sequence |
+ | * **Time** interval before switching to a new color, in seconds | ||
+ | ++++ | ||
- | == Start RGB sequence | + | ++++Stop |
+ | ++++ | ||
- | Repeats | + | ++++Save |
+ | * **Preset position** number of the slot where the color should be saved (value | ||
+ | ++++ | ||
- | == Stop the RGB sequence and turn off == | + | ++++Recall the color previously saved to the selected preset position| |
- | + | * **Preset position** number | |
- | Stops the repetition | + | ++++ |
===== Email account ===== | ===== Email account ===== | ||
Line 385: | Line 540: | ||
* When using the Generic Command button, select Internal Services --> Email Account --> Your Email Account object --> Send email to recipients and fill the parameters as desired. | * When using the Generic Command button, select Internal Services --> Email Account --> Your Email Account object --> Send email to recipients and fill the parameters as desired. | ||
* When using the Report object, select Report from System tab, and disable the Default SMTP in the parameters. Then select your Email Account from the dropdown list instead. | * When using the Report object, select Report from System tab, and disable the Default SMTP in the parameters. Then select your Email Account from the dropdown list instead. | ||
- | ==== Object commands ==== | ||
- | Commands sent to the object and recallable from other objects: | ||
- | == Send Email to recipients == | ||
- | Allows to send an email message using a customisable personal account; define the email subject, content and recipients by adjusting the parameters on the right. | + | ==== Object commands ==== |
- | + | ||
- | * Subject of the mail message that will be sent to the specified recipients | + | |
- | * Recipients email addresses, separeted by ; | + | |
- | * Text content of the mail message. | + | |
+ | Commands sent to the object and recallable from other objects: | ||
+ | ++++Send Email to recipients| | ||
+ | * **Email subject** | ||
+ | * **Email recipients** separate the emails using " ; ". | ||
+ | * **Email content** body of the email. | ||
+ | ++++ | ||
===== Web UI ===== | ===== Web UI ===== | ||
Line 445: | Line 599: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
+ | ++++Start the presence simulation| | ||
+ | ++++ | ||
+ | ++++Stop the presence simulation| | ||
+ | ++++ | ||
- | == Start the presence simulator == | ||
- | |||
- | Starts the presence simulator sequence of actions. | ||
- | |||
- | == Stop the presence simulator == | ||
- | |||
- | Ends the presence simulator sequence of actions. | ||
===== Sun times and events ===== | ===== Sun times and events ===== | ||
Line 485: | Line 636: | ||
* **Command** Command performed by the server when the sun event occurs. | * **Command** Command performed by the server when the sun event occurs. | ||
+ | ====== Security ====== | ||
===== Alarm device ===== | ===== Alarm device ===== | ||
Line 493: | Line 644: | ||
+ | |||
+ | ===== Access Control ===== | ||
+ | The Thinknx Access Control object permits to enhance the level of automation and security of the home/ | ||
+ | |||
+ | The Access Control object can communicate directly with the KNX system because of the bus connector on the Thinknx server, making the integration very easy and flexible. Any standard KNX keypad can be used as an access keypad, and the buttons as code entries. Once the code is inserted, any lock or switch connected to a KNX actuator can be operated. In addition, communication with Wiegand technology is possible through the Thinknx-Wiegand adapter, making it possible to install a suitable RFID or biometric reader. | ||
+ | |||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
+ | |||
+ | * **Label** Text to identify the object | ||
+ | * **Code length** Number of digits inside the access codes. All codes should have the same number of digits. If length of codes is 6, a valid code will be 123456. | ||
+ | * **Code numbers** Numbers contained inside the code, starting from 0. This depends on the number of buttons in keypads. If code numbers is 5, codes can contain the numbers 0,1,2,3,4. | ||
+ | * **Confirm time (ms)** Maximum time between two consecutive keypress. Once the confirm time has been exceeded, the start of a new code will considered on keypress. This time is useful to start a new sequence if a mistake has been made when entering the code. | ||
+ | * **Guard wrong codes** if enabled, it is possible to monitor wrong codes attempts, and generate events once a threshold has been reached. | ||
+ | * **Number of attempts** Maximum number of attempts with wrong codes allowed before triggering the event. | ||
+ | * **attempts interval (s)** duration in seconds used to count the number of wrong attempts before triggering the event. If the number of wrong attempts exceeds the number of attempts set previously during the attempt interval, then the event for wrong codes will be fired. | ||
+ | |||
+ | ==== Keypad prototypes ==== | ||
+ | Collection of prototypes used for the installed keypads. To add and configure a prototype, click on the small button to the right to access the prototype creator window. For each added prototype, the following properties are available: | ||
+ | * **Name** label of the prototype used. | ||
+ | * **Technology** technology used for the created protoype. The available options are: | ||
+ | * Doory (Blumotix) | ||
+ | * Generic KNX | ||
+ | * Generic Wiegand //coming soon// | ||
+ | * Wiegand over network //coming soon// | ||
+ | If " | ||
+ | * **KNX Data Type** Data type used on the KNX buttons to send the access code digits. Each button can be configured to send a 1bit object to a different KNX group, or send a certain value on a 1byte object corresponding to the digit on the same KNX group. | ||
+ | * **Delete Key** if enabled, this option will delete the inserted sequence and start a new one before the " | ||
+ | * **Confirm tone** if enabled, the system will generate an event " | ||
+ | * **Keys** //only visible if **KNX Data Type** is DPT 1 (bit).// This parameter holds the keys collection used to enter a code. Clicking on the small right button will open the Keys Manager. From there, it is possible to configure every single key. Each key has a **name**, **key type** and a **group address**. | ||
+ | * **KNX group for keys** //only visible if **KNX Data Type** is DPT 5 (Unsigned byte).// It holds the group address used on the keypad to sen the different code digits. A telegram with value 4 means that button 4 has been pressed on the keypad. | ||
+ | |||
+ | |||
+ | ==== Keypads ==== | ||
+ | This parameter holds the collection of keypads used and installed on the plant. At least one keypad protocol must be created prior adding the keypads. Clicking on the small button to the right will open the Keypads Manager. Each added keypad will have the following parameters: | ||
+ | * **Name** device label | ||
+ | * **Prototype** communication prototype used for this device. A prototype must be created in **Keypads Prototype** in order to view it in the list here. | ||
+ | * **KNX physical address** physical address of the device. | ||
+ | * **KNX group for code enabled** KNX group used by keypad to signal that the code is enabled (1 bit data type). | ||
+ | * **KNX group for storing/ | ||
+ | * **KNX group for erase request** KNX group to erase codes from the keypad (1 bit data type). | ||
+ | * **Command if fail** command to execute in case of failed entry attempt. | ||
+ | * **Command if success** command to execute in case of successful entry. | ||
+ | * **command for tone** command to execute to play tone. | ||
+ | ==== Areas ==== | ||
+ | This parameter holds the collection of all the areas (rooms or part of the building) limited by one or more access control keypads. By clicking on the small button to the right, the Area Manager is accessible. Each added area will have the following parameters: | ||
+ | * **Name** label of the area. | ||
+ | * **Entrance doors** allows you to select the checkers that are used on site to enter this specific area. The checkers should be created first in the **Keypads** collection. | ||
+ | * ** Dual flow** id disabled, the entrance checkers will be considered for both entrance and exit. If enabled, it means the area has differet doors/ | ||
+ | * **Exit doors** //only visible if **Dual flow** is enabled.// allows you to select the checkers that are used on site to exit this specific area. The checkers should be created first in the **Keypads** collection. | ||
+ | * **Count persons** //only visible if **Dual flow** is enabled.// If enabled, the system will count the number of persons inside the area based on the entrance and exit events. | ||
+ | * **Success enter command** Command to execute in case of successful entrance event. | ||
+ | * **Success exit command** Command to execute in case of successful exit event. | ||
+ | * **Nobody command** //only visit if **Count persons** is enabled.// Command to execute in case nobody is in the area. | ||
+ | * **KNX group force closed** KNX group (1 bit DPT1) to force all doors/ | ||
+ | * **KNX group force open** KNX group (1 bit DPT1) to force all doors/ | ||
+ | * **KNX group valid enter** KNX gorup (1bit DPT1) to signal a valid entrance into the area. | ||
+ | * **KNX group valide exit** KNX group (1bit DPT1) to signal a valid exit from the area. | ||
+ | |||
+ | ==== Timing ==== | ||
+ | // information coming soon// | ||
+ | ==== Roles ==== | ||
+ | |||
+ | // information coming soon// | ||
+ | |||
+ | ====== Logic ====== | ||
===== Combination ===== | ===== Combination ===== | ||
Line 659: | Line 876: | ||
* **KNX group** This property represents the KNX group which the value of the addend can be picked from. | * **KNX group** This property represents the KNX group which the value of the addend can be picked from. | ||
- | ===== Complex | + | ===== Logic Module ===== |
+ | |||
+ | {{ : | ||
+ | |||
+ | This object represents a collection of block diagrams which allows you to build complex logics with a graphical editor. For more informations please refer to the [[logic_module|Logic Module section]]. | ||
+ | |||
+ | * **Schemes** List of schemes, each element represents a fully working block diagram. | ||
+ | |||
+ | ===== Complex | ||
{{ : | {{ : | ||
Line 809: | Line 1034: | ||
</ | </ | ||
+ | ====== Reports and Gateways ====== | ||
===== Report ===== | ===== Report ===== | ||
Line 932: | Line 1157: | ||
==== Object commands ==== | ==== Object commands ==== | ||
- | Commands sent to the object and recallable from other objects | + | Commands sent to the object and recallable from other objects: |
- | + | ||
- | == Turn on/off element == | + | |
- | + | ||
- | Turn on or off the Hue element. Set 1 as parameter turn on the element, while 0 turn off the element. | + | |
- | + | ||
- | == Dimm the element to a value == | + | |
- | + | ||
- | set the desired value for the dimmer through a single parameter which can assume a value between 0 and 255. | + | |
- | + | ||
- | == Set the element color temperature (white) == | + | |
- | Set the element | + | ++++Turn on/off element| |
+ | * **Value** Write 1 to turn on, and 0 to turn off. | ||
+ | ++++ | ||
+ | ++++Dimm the element to a value| | ||
+ | * **Value** can be between 0 and 255. | ||
+ | ++++ | ||
+ | ++++Set the element color temperature (white)| | ||
+ | * **Value** Can be between | ||
+ | ++++ | ||
+ | ++++Set the element color (RGB)| | ||
+ | * **Red Value** value between 0 and 255. | ||
+ | * **Green Value** value between 0 and 255. | ||
+ | * **Blue Value** value between 0 and 255. | ||
+ | ++++ | ||
- | == Set the element color (RGB) == | ||
- | |||
- | Set the element RGB color through the definition of three parameters for Red, Green and Blue. Each color can assume a value between 0 and 255. | ||
- | |||
- | ===== MyHome Gateway ===== | ||
- | |||
- | {{ : | ||
- | |||
- | It allows the bidirectional connection of MyHome BTicino plants to KNX plants. Through easy-to-fit tables it is possible to set matching among the messages coming from the two worlds. | ||
- | |||
- | * **IP Address** IP address of the device or of the serial server | ||
- | * **Port Number** Serial port number. It can be between 0 and 3. For USB use 10 | ||
- | * **Lights** Collection of lights | ||
- | * **Automation** | ||
- | * **Heating** Collection of heating and cooling elements. | ||
===== Load control ===== | ===== Load control ===== | ||
Line 989: | Line 1202: | ||
{{ : | {{ : | ||
- | It allows to integrate Modbus devices. | + | It allows to integrate Modbus devices |
* **Communication Type** Define the method and mean of communication. Serial over TCP is used when a Serial Server is used.\\ If in the property ”Communication Type” is selected the setting ”Modbus Serial”, the following properties will appear: | * **Communication Type** Define the method and mean of communication. Serial over TCP is used when a Serial Server is used.\\ If in the property ”Communication Type” is selected the setting ”Modbus Serial”, the following properties will appear: | ||
- | * Port Number: Serial port number. | + | * Port Number: Serial port number |
+ | * Compact: use 0. | ||
+ | * Rack: for the 2 RS-232 ports use 0 and 1. For the additional green ports use 2 and 3. | ||
+ | * Brickbox: for RS-232 use 4. For RS-485 use 5. | ||
+ | * When using a USB port, use 10. | ||
* Baud Rate: Modbus Baud Rate | * Baud Rate: Modbus Baud Rate | ||
* Data Length: Number of bits for data | * Data Length: Number of bits for data | ||
Line 1003: | Line 1220: | ||
* **Datapoints** Data points collection | * **Datapoints** Data points collection | ||
* **Poll Interval** Pause between two consecutive polling sequences [ms] | * **Poll Interval** Pause between two consecutive polling sequences [ms] | ||
+ | |||
+ | ==== Object Commands ==== | ||
+ | Commands sent to the object and recallable from other objects: | ||
+ | ++++Send Modbus value with function 5| This function is used to send a value to a Modbus device supporting function 5, known as "write single coil". | ||
+ | * **Modbus address** Modbus address. | ||
+ | * **Coil Address** Discrete output address (coils are 1-bit registers). | ||
+ | * **Value** could be 1 or 0. | ||
+ | ++++ | ||
+ | ++++Send Modbus value with function 6| This function is used to send a value to a Modbus device supporting function 6, known as "Write Single Holding Register" | ||
+ | * **Modbus Address** Modbus address. | ||
+ | * **Register Address** Slave register. | ||
+ | * **Value** value to write. | ||
+ | * **N.Byte** Number of bytes. | ||
+ | ++++ | ||
+ | ++++Send Modbus value with function 16| This function is used to send a value to a Modbus device supporting function 16, known as "Write Multiple Holding Registers" | ||
+ | * **Modbus Address** Modbus address. | ||
+ | * **First Register Address** Slave register. | ||
+ | * **Value** value to write. | ||
+ | * **N.Byte** Number of bytes. | ||
+ | ++++ | ||
+ | ++++Send Modbus value with function 22| This function is used to send a value to a Modbus device supporting function 22. The function can be used to set or clear individual bits in the register. | ||
+ | * **Modbus Address** Modbus address. | ||
+ | * **Register Address** Slave register. | ||
+ | * **Value** value to write. | ||
+ | * **Selected bits mask** mask value of the selected bits to be changed. | ||
+ | ++++ | ||
+ | |||
+ | ===== Gateway Modbus Slave===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | It allows to integrate Modbus devices when Thinknx server is used as Slave. | ||
+ | |||
+ | * **Communication Type** Define the method and mean of communication. Serial over TCP is used when a Serial Server is used.\\ If in the property ”Communication Type” is selected the setting ”Modbus Serial”, the following properties will appear: | ||
+ | * Port Number: Serial port number that changes depending on the server used: | ||
+ | * Compact: use 0. | ||
+ | * Rack: for the 2 RS-232 ports use 0 and 1. For the additional green ports use 2 and 3. | ||
+ | * Brickbox: for RS-232 use 4. For RS-485 use 5. | ||
+ | * When using a USB port, use 10. | ||
+ | * Baud Rate: Modbus Baud Rate | ||
+ | * Data Length: Number of bits for data | ||
+ | * Parity: Parity check modality | ||
+ | * Stop Bits: Number of stop bits. | ||
+ | * Custom Timing: if enabled, it allows to change the waiting times below: | ||
+ | * waiting time after enabling RTS before the writing begins. | ||
+ | * waiting time after writing before disabling RTS. | ||
+ | * waiting time after disabling RTS before the reading begins. | ||
+ | |||
+ | * **Device Address** Address of the slave device (1byte) to be used on the bus for identification. | ||
+ | * **Modbus Type** variant of the Modbus protocol to use for communication. Select between RTU (mostly used) and ASCII. | ||
+ | * **Datapoints** Datapoints collection | ||
+ | |||
+ | |||
+ | |||
+ | ===== Gateway MyHome ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | It allows the bidirectional connection of MyHome BTicino plants to KNX plants. Through easy-to-fit tables it is possible to set matching among the messages coming from the two worlds. | ||
+ | |||
+ | * **IP Address** IP address of the device or of the serial server | ||
+ | * **Port Number** Serial port number that changes depending on the server used: | ||
+ | * Compact: use 0. | ||
+ | * Rack: for the 2 RS-232 ports use 0 and 1. For the additional green ports use 2 and 3. | ||
+ | * Brickbox: for RS-232 use 4. For RS-485 use 5. | ||
+ | * When using a USB port, use 10. | ||
+ | * **Lights** Collection of lights | ||
+ | * **Automation** | ||
+ | * **Heating** Collection of heating and cooling elements. | ||
+ | |||
+ | ==== Object Commands ==== | ||
+ | Commands sent to the object and recallable from other objects: | ||
+ | |||
+ | ++++Launch a scenario| This command allows launching of a scenario configured on the MyHome system. | ||
+ | * **Scenario Number** as configured in MyHome. | ||
+ | * **Control Panel** | ||
+ | * **Interface (I)** | ||
+ | ++++ | ||
+ | ++++Lights: point to point control ON/OFF| This command allows to send an ON or OFF command to one lighting point. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Light Point (PL)** | ||
+ | * **Interface (I)** | ||
+ | * **ON/OFF** type 0 to turn off and 1 to turn on. | ||
+ | ++++ | ||
+ | ++++Lights: point to point control DIMMER| This command allows to send a dimming value to one dimmer. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Light Point (PL)** | ||
+ | * **Interface (I)** | ||
+ | * **Dimmer Level** type a value between 0 and 255 for dimmer' | ||
+ | ++++ | ||
+ | ++++Lights: point to point control TIMED| This command allows to send an ON value duration for one light point. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Light Point (PL)** | ||
+ | * **Interface (I)** | ||
+ | * **ON timed for (min)** the values can be 0.5, 1, 2, 3, 4,5, or 15 min. | ||
+ | ++++ | ||
+ | ++++Lights: control for room ON/OFF| This command allows to send an ON or OFF command to an entire room. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **ON/OFF** type 0 to turn off and 1 to turn on. | ||
+ | ++++ | ||
+ | ++++Lights: control for room TIMED| This command allows to send an ON value duration for an entire room. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **ON timed for (min)** the values can be 0.5, 1, 2, 3, 4,5, or 15 min. | ||
+ | ++++ | ||
+ | ++++Lights: control for group ON/OFF| This command allows to send an ON or OFF command to a group of lighting points. | ||
+ | * **Group** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **ON/OFF** type 0 to turn off and 1 to turn on. | ||
+ | ++++ | ||
+ | ++++Lights: control for group DIMMER| This command allows to send a dimming value to a group of lighting points. | ||
+ | * **Group** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **Dimmer Level** type a value between 0 and 255 for dimmer' | ||
+ | ++++ | ||
+ | ++++Lights: control for group TIMED| This command allows to send an ON value duration for a group of lighting points. | ||
+ | * **Group** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **ON timed for (min)** the values can be 0.5, 1, 2, 3, 4,5, or 15 min. | ||
+ | ++++ | ||
+ | ++++Lights: general control ON/OFF| This command allows to send an ON or OFF command to all lighting points. | ||
+ | * **ON/OFF** type 0 to turn off and 1 to turn on. | ||
+ | ++++ | ||
+ | ++++Lights: general control DIMMER| This command allows to send a dimming value to all lighting points. | ||
+ | * **Dimmer Level** type a value between 0 and 255 for dimmer' | ||
+ | ++++ | ||
+ | ++++Lights: general control TIMED| This command allows to send an ON value duration for all lighting points. | ||
+ | * **ON timed for (min)** the values can be 0.5, 1, 2, 3, 4,5, or 15 min. | ||
+ | ++++ | ||
+ | ++++Automation: | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Automation Point (PL)** | ||
+ | * **Interface (I)** | ||
+ | * **Stop/ | ||
+ | ++++ | ||
+ | ++++Automation: | ||
+ | * **Group** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **Stop/ | ||
+ | ++++ | ||
+ | ++++Automation: | ||
+ | * **Room** as configured in MyHome. | ||
+ | * **Interface (I)** | ||
+ | * **Stop/ | ||
+ | ++++ | ||
+ | ++++Automation: | ||
+ | * **Stop/ | ||
+ | ++++ | ||
+ | ++++Temperature Control: Setpoint| This command allows to change the setpoint in a zone. | ||
+ | * **Zone (ZA, ZB)** as configured in MyHome. | ||
+ | * **Temperature** type the value of the temperature in °C. | ||
+ | ++++ | ||
+ | ++++Temperature Control: enable or disable| This command allows to enable/ | ||
+ | * **Zone (ZA, ZB)** as configured in MyHome. | ||
+ | * **Enable or disable** type 1 to enable and 0 to disable. | ||
+ | ++++ | ||
+ | ++++Sound: Control the volume| This command allows to control the volume of a speaker. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Loudspeaker (PF)** | ||
+ | * **Volume** the number must be between 0 and 255. | ||
+ | ++++ | ||
+ | ++++Sound: control a speaker ON/OFF| This command allows to turn a speaker on or off. | ||
+ | * **Room (A)** as configured in MyHome. | ||
+ | * **Loudspeaker (PF)** | ||
+ | * **ON/OFF** insert 1 to turn on and 0 to turn off. | ||
+ | ++++ | ||
===== Z-Wave Controller ===== | ===== Z-Wave Controller ===== | ||
Line 1008: | Line 1392: | ||
{{ : | {{ : | ||
- | It allows to integrate Z-Wave devices. Without any gateway, the result is a reliable and easy-to-use system with a bidirectional connection between Z-Wave and other standards such as KNX. | + | It allows to integrate Z-Wave devices. Without any gateway, the result is a reliable and easy-to-use system with a bidirectional connection between Z-Wave and other standards such as KNX. |
+ | |||
+ | <WRAP important center round 60%> For a full list of all the compatible Z-wave devices with Thinknx server, visit this link here http:// | ||
* **Use internal controller** If enable, it will be used the server internal Z-Wave controller. If disabled it will be possible to use an external Z-Wave controller. This option is only used during configuration phase. If disabled, following properties will appear: | * **Use internal controller** If enable, it will be used the server internal Z-Wave controller. If disabled it will be possible to use an external Z-Wave controller. This option is only used during configuration phase. If disabled, following properties will appear: | ||
Line 1167: | Line 1553: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Send SMS to numbers with text == | + | ++++Send SMS to numbers with text| This function allows the sending of an SMS to multiple phone numbers. |
- | + | * **SMS text content** message body. | |
- | Sends an SMS. In the parameters specify the SMS content | + | * **Receivers phone numbers** use " |
+ | ++++ | ||
===== Lutron ===== | ===== Lutron ===== | ||
Line 1191: | Line 1577: | ||
After adding the Lutron object in the System, the user can proceed to create a page in the Interface section and add to it some Switch and/or Shutter objects. For each of those objects, it is possible to select Lutron as "Bus Type" in their corresponding parameters window, and link them to the Lutron Gateway and Lutron Output selected from the imported project tree. | After adding the Lutron object in the System, the user can proceed to create a page in the Interface section and add to it some Switch and/or Shutter objects. For each of those objects, it is possible to select Lutron as "Bus Type" in their corresponding parameters window, and link them to the Lutron Gateway and Lutron Output selected from the imported project tree. | ||
+ | {{ : | ||
+ | <WRAP center 60%> <WRAP centeralign> | ||
==== Actions from Lutron ==== | ==== Actions from Lutron ==== | ||
This editor allows to create an action that will be launched whenever an event on Lutron bus is happening. The action can be set to any command from the Generic Commands inside the Thinknx server. For example, when a Lutron light is turned on, it is possible to send a push notification to the clients. For more information regarding the available actions, see our [[# | This editor allows to create an action that will be launched whenever an event on Lutron bus is happening. The action can be set to any command from the Generic Commands inside the Thinknx server. For example, when a Lutron light is turned on, it is possible to send a push notification to the clients. For more information regarding the available actions, see our [[# | ||
Line 1279: | Line 1666: | ||
This object represents the interface between ThinKnx system and a third-party device connected through serial port. It makes possible to send commands through the serial port to the device. | This object represents the interface between ThinKnx system and a third-party device connected through serial port. It makes possible to send commands through the serial port to the device. | ||
- | * **Port Number** Serial port number. | + | * **Port Number** Serial port number |
+ | * Compact: use 0. | ||
+ | * Rack: for the 2 RS-232 ports use 0 and 1. For the additional green ports use 2 and 3. | ||
+ | * Brickbox: for RS-232 use 4. For RS-485 use 5. | ||
+ | * When using a USB port, use 10. | ||
* **Baud Rate** Serial port baud rate. | * **Baud Rate** Serial port baud rate. | ||
* **Data Length** Number of bits for data. | * **Data Length** Number of bits for data. | ||
Line 1289: | Line 1680: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Send string with no termination | + | ++++Send string with no termination| This command is used to send a text without termination. |
- | + | * **String to send** input the string | |
- | Sends a string to the serial | + | ++++ |
- | + | ++++Send string with CR termination| This command is used when sending | |
- | == Send string with CR termination | + | * **String |
- | + | ++++ | |
- | Sends a string to the serial port with carriage return; adjust | + | ++++Send hexadecimal string with no termination| This command is used to send an hexadecimal string without |
- | + | * **String | |
- | == Send hexadecimal string with no termination | + | ++++ |
- | + | ++++Send hexadecimal string with CR termination| This command is used when sending an hexadecimal string with CR termination, | |
- | Sends a hexadecimal string | + | * **String |
- | + | ++++ | |
- | == Send hexadecimal string with CR termination | + | |
- | + | ||
- | Sends a hexadecimal string | + | |
==== Serial port settings for ThinKnx servers ==== | ==== Serial port settings for ThinKnx servers ==== | ||
Line 1327: | Line 1715: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Make a http GET call to a specific | + | ++++Make an HTTP GET call to a specified |
+ | * **URL** | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
- | Allows | + | ++++Make an HTTP GET call to a specified url with username and password| This command allows |
+ | * **URL** | ||
+ | * **Username** used to authenticate to the server | ||
+ | * **Password** used to authenticate | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
- | == Make a http GET call to a specific | + | ++++Make an HTTP POST call to a specified |
+ | * **URL** | ||
+ | * **Content to send into call** multiple form fields and values can be sent via the same URL. The encoding used by default is based on an early version of the general URI percent-encoding rules, with a number of modifications such as newline normalization and replacing spaces | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
- | Allows | + | ++++Make an HTTP POST call to a specified url with username and password| This command allows the sending of an HTTP POST request |
+ | * **URL** | ||
+ | * **Content to send into call** multiple form fields and values can be sent via the same URL. The encoding used by default is based on an early version of the general URI percent-encoding rules, with a number of modifications such as newline normalization | ||
+ | * **Username** used the authenticate to the server. | ||
+ | * **Password** used to authenticate | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | ++++ | ||
- | == Make a http POST call to a specific url == | + | ++++Send string with no termination to TCP socket| This command allows the sending of a string |
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | ++++ | ||
- | Allows | + | ++++Send string with CR termination |
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | ++++ | ||
- | == Make a http POST call to a specific url with username == | + | ++++Send hexadecimal string with no termination to TCP socket| This command allows the sending of an hexadecimal string |
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
- | Allows to send a POST; adjust the ”URL” parameter on the right to specify the url and type in the login parameters required for the authentication | + | To send "hello world", |
+ | ++++ | ||
- | == Send string with no termination to TCP socket | + | ++++Send hexadecimal |
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
- | Allows to send a string | + | To send "hello world", |
+ | ++++ | ||
- | == Send string with CR termination to TCP socket | + | ++++Send string with no termination to UDP socket| This command allows the sending of an hexadecimal string to a UDP host on a defined port. |
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | ++++ | ||
- | Allows to send a string to a TCP socket | + | ++++Send |
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | ++++ | ||
- | == Send hexadecimal string with no termination to TCP socket | + | ++++Send hexadecimal string with no termination to UDP socket| This command allows the sending of an hexadecimal string to a UDP host on a defined port. |
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | To send "hello world", | ||
+ | ++++ | ||
- | Allows to send a hexadecimal string to a TCP socket | + | ++++Send |
+ | * **String | ||
+ | * **Host: | ||
+ | * **Timeout for connection** | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | To send "hello world", | ||
+ | ++++ | ||
- | == Send hexadecimal string with CR termination to TCP socket | + | ++++Send hexadecimal string with no termination to UDP socket |
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
- | Allows to send a hexadecimal string | + | To send "hello world", |
+ | ++++ | ||
- | == Send string with no termination to UDP socket | + | ++++Send hexadecimal |
+ | * **String to send** | ||
+ | * **Host: | ||
+ | * **Timeout for connection** in milliseconds, | ||
+ | * **Time to wait before closing connection after data sending** in milliseconds, | ||
+ | To send "hello world", | ||
+ | ++++ | ||
- | Allows | + | ++++Send SOAP request |
+ | * **URL** | ||
+ | * **SOAP Envelope** Defines | ||
+ | * **SOAP Action** indicates | ||
+ | ++++ | ||
- | == Send string | + | ++++Establish SSH session and send commands| This command allows to establish an SSH session |
+ | * **SSH server hostname** | ||
+ | * **SSH server port** | ||
+ | * **Username** | ||
+ | * **Password** | ||
+ | * **Commands | ||
- | Allows to send a string to a UDP socket with carriage return; adjust the parameters on the right to specify the string text and type in the IP address and port of the server. | + | Application: |
- | + | ++++ | |
- | == Send hexadecimal string with no termination to UDP socket == | + | |
- | + | ||
- | Allows to send a hexadecimal string to a UDP socket without carriage return; adjust the parameters on the right to specify the string text and type in the IP address and port of the server. The string command has to be converted in hexadecimal, | + | |
- | + | ||
- | == Send hexadecimal string with CR termination | + | |
- | + | ||
- | Allows | + | |
- | + | ||
- | == Send SOAP request to the specified URL == | + | |
- | + | ||
- | Allows to send a SOAP request; adjust the parameters on the right to specify the destination URL, the SOAP envelope and the SOAP action of the request. | + | |
===== P1 Meter Interface ===== | ===== P1 Meter Interface ===== | ||
Line 1399: | Line 1856: | ||
* KNX group calorie cool: KNX group calorie cool. | * KNX group calorie cool: KNX group calorie cool. | ||
* KNX water consumption: | * KNX water consumption: | ||
+ | |||
+ | ===== Voice Control Gateway ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | This object allows you to control the house by sending voice commands to your voice enabled device, whether it was via Siri (Apple Homekit), Alexa (Amazon Echo) or Google Assistant. For more information please refer to the [[voice_control|Voice Control Gateway section]]. | ||
+ | |||
+ | * **Label** Text label to identify the object | ||
+ | * **Lights** Holds the collection of Light objects added | ||
+ | * **Rollers Shutters** Holds the collection of Shutter objects added | ||
+ | * **Thermo Comfort** Holds the collection of Thermo Comfort objects added | ||
+ | * **Scenes** Holds the collection of Scene objects added | ||
+ | |||
+ | ===== IFTTT Account ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | This object allows you to connect with IFTTT service to create automated tasks between a wide array of apps, services, and devices. For more information please refer to the [[ifttt|IFTTT section]]. | ||
+ | |||
+ | * **Label** Text label to identify the object | ||
+ | * **Webhook Key** Webhook key of the user account to use to communicate with IFTTT service. Can be obtained visiting this URL: < | ||
===== Tester ===== | ===== Tester ===== | ||
Line 1434: | Line 1912: | ||
If the “Test type” is set to “Ping KNX Device” the following property will appear: | If the “Test type” is set to “Ping KNX Device” the following property will appear: | ||
* **KNX Physical Addr.** KNX physical address of the test target | * **KNX Physical Addr.** KNX physical address of the test target | ||
+ | ====== Multimedia ====== | ||
===== Video Matrix ===== | ===== Video Matrix ===== | ||
Line 1453: | Line 1931: | ||
* IP address: Device IP address. | * IP address: Device IP address. | ||
* Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, | * Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, | ||
- | * Serial port: Server serial | + | * Serial port: Serial |
+ | * Compact: use 0. | ||
+ | * Rack: for the 2 RS-232 ports use 0 and 1. For the additional green ports use 2 and 3. | ||
+ | * Brickbox: for RS-232 use 4. For RS-485 use 5. | ||
+ | * When using a USB port, use 10. | ||
==== Object commands ==== | ==== Object commands ==== | ||
Line 1459: | Line 1941: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Set the selected | + | ++++Disconnect |
+ | ++++ | ||
- | Associates a specified | + | ++++Disconnect |
+ | * **Output Number** | ||
- | == Disconnect input for the selected output == | + | ++++ |
- | Disconnects a specified | + | ++++Set the selected |
+ | * **Input Number** | ||
+ | * **Output Number** | ||
+ | ++++ | ||
- | == Disconnect input for every output == | ||
- | |||
- | Resets all the previously configured connection between inputs and outputs of the video matrix. | ||
===== Audio Matrix ===== | ===== Audio Matrix ===== | ||
Line 1488: | Line 1972: | ||
* IP address: Device IP address. | * IP address: Device IP address. | ||
* Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, | * Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, | ||
- | * Serial port: Server serial | + | * Serial port: Serial |
+ | * Compact: use 0. | ||
+ | * Rack: for the 2 RS-232 ports use 0 and 1. For the additional green ports use 2 and 3. | ||
+ | * Brickbox: for RS-232 use 4. For RS-485 use 5. | ||
+ | * When using a USB port, use 10. | ||
* **Mute KNX Group** KNX group for mute command. | * **Mute KNX Group** KNX group for mute command. | ||
Line 1495: | Line 1983: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Set the selected input for a selected output | + | ++++Set the selected input ot the selected output| This command will allow to set the desired input to one or more multiple outputs. |
+ | * **Input Number** | ||
+ | * **Output Number** use comma "," | ||
+ | ++++ | ||
- | Associates a specified | + | ++++Disconnect |
+ | ++++ | ||
- | == Disconnect input for the selected output == | + | ++++Mute or unmute |
+ | * **Output Number** use comma "," | ||
+ | * **Mute Value** 1=muted, 0=unmuted. | ||
+ | ++++ | ||
- | Disconnects a specified input from the previously specified | + | ++++Volume up selected |
+ | * **Output Number** use comma "," | ||
+ | ++++ | ||
- | == Disconnect input for every output | + | ++++Volume down selected |
+ | * **Output Number** use comma "," | ||
+ | ++++ | ||
- | Resets all the previously configured connection between inputs and outputs of the audio matrix. | + | ++++Set volume for selected output| This command will allow to set the a desired |
- | + | * **Output Number** use comma "," to send to multiple outputs. | |
- | == Mute or unmute | + | * **Volume** |
- | + | ++++ | |
- | Temporarily mutes a selected output; several output numbers, separated by a comma, can be typed in the ”Output number” parameter. The ”Mute” bit value can be adjusted in the related parameter as well. | + | |
- | + | ||
- | == Volume up selected output == | + | |
- | + | ||
- | Turns up the volume | + | |
- | + | ||
- | == Volume down selected output | + | |
- | + | ||
- | Turns down the volume of a specified output (several output numbers, separated by a comma, | + | |
- | + | ||
- | == Set volume for selected output == | + | |
- | + | ||
- | Configures a specified volume | + | |
===== Display ===== | ===== Display ===== | ||
Line 1533: | Line 2019: | ||
* //TV brand LCD// | * //TV brand LCD// | ||
* //TV brand NEC// | * //TV brand NEC// | ||
- | * **Serial port** | + | * **Serial port** |
+ | * Compact: use 0. | ||
+ | * Rack: for the 2 RS-232 ports use 0 and 1. For the additional green ports use 2 and 3. | ||
+ | * Brickbox: for RS-232 use 4. For RS-485 use 5. | ||
+ | * When using a USB port, use 10. | ||
==== Object Commands ==== | ==== Object Commands ==== | ||
Line 1539: | Line 2029: | ||
Commands that can be recalled from other objects: | Commands that can be recalled from other objects: | ||
- | == Set the TV channel number | + | ++++Set the TV channel number| This command will allow to change the TV channel to the desired channel entered inside the parameter. |
+ | * **Channel Number** | ||
+ | ++++ | ||
- | Change channel on the TV to the desired number. | + | ++++Set |
+ | * **Source Number** | ||
+ | ++++ | ||
- | == Set the video source | + | ++++On or standby the device| |
+ | * **Power Value** 1=Power ON, 0=Standby. | ||
+ | ++++ | ||
- | Set the video source. | + | ++++Set the audio volume| |
+ | * **Volume Level** value between 0-100. | ||
+ | ++++ | ||
- | == Muet or unmute | + | ++++Set |
+ | ++++ | ||
- | Set mute or unmute. | + | ++++Set the audio volume down| This command will allow to lower the volume on the TV. |
+ | ++++ | ||
- | == On or standby the device == | ||
- | |||
- | Turn on the device or put it in standby. | ||
- | |||
- | == Set the audio volume == | ||
- | |||
- | Set the volume | ||
- | |||
- | == Set the audio volume up == | ||
- | |||
- | Raise the volume | ||
- | |||
- | == Set the audio volume down == | ||
- | |||
- | Lower the volume | ||
===== Home theater ===== | ===== Home theater ===== | ||
Line 1580: | Line 2065: | ||
* IP address: Device IP address. | * IP address: Device IP address. | ||
* Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, | * Port number: TCP/IP port number for ethernet connection.\\ If the property ”Use serial port” is set to ”Enabled”, | ||
- | * Serial port: Server serial | + | * Serial port: Serial |
+ | * Compact: use 0. | ||
+ | * Rack: for the 2 RS-232 ports use 0 and 1. For the additional green ports use 2 and 3. | ||
+ | * Brickbox: for RS-232 use 4. For RS-485 use 5. | ||
+ | * When using a USB port, use 10. | ||
==== Object commands ==== | ==== Object commands ==== | ||
Line 1587: | Line 2075: | ||
Commands that can be recalled from other objects: | Commands that can be recalled from other objects: | ||
- | == Power On or Standby device | + | ++++Power On or Standby device| This command will allow to turn the device On or put it to Standby mode. The command is sent to each zone individually. |
+ | * **Subzone** | ||
+ | * **power value** this value varies depending on the Brand of the Home Theater device. For more information, | ||
+ | ++++ | ||
- | Power on or standby | + | ++++Mute |
+ | * **Subzone** | ||
+ | * **mute value** this value varies depending on the Brand of the Home Theater | ||
+ | ++++ | ||
- | == Mute or unmute | + | ++++Volume up main output| This command will allow to raise the volume on the selected subzone. |
+ | * **Subzone** | ||
+ | ++++ | ||
- | Mute or unmute the main output. | + | ++++Volume down main output| This command will allow to lower the volume on the selected subzone. |
+ | * **Subzone** | ||
+ | ++++ | ||
- | == Enable or disable Subwoofer == | + | ++++Set volume for main output| |
+ | * **Subzone** | ||
+ | * **Volume** value between 0-100. | ||
+ | ++++ | ||
- | Enable or disable | + | ++++Bass up main output| |
+ | ++++ | ||
- | == Enable or disable OSD == | + | ++++Bass down main output| |
+ | ++++ | ||
- | Enable or disable | + | ++++Treble up main output| |
+ | ++++ | ||
- | == Volume up main output | + | ++++Treble down main output| This command will allow to lower the treble on the output. |
+ | ++++ | ||
- | Raise the main output volume | + | ++++Enable or disable Subwoofer| |
+ | * **Sub enable** | ||
+ | ++++ | ||
- | == Volume down main output | + | ++++Select source for main output| This command will allow to set the desired source to the main output of the selected zone. |
+ | * **Subzone** | ||
+ | * **Main source** | ||
+ | ++++ | ||
- | Lower the main output volume | + | ++++Select audio source for selected main source| |
+ | * **Subzone** | ||
+ | * **Main source audio** | ||
+ | ++++ | ||
- | == Set volume | + | ++++Select video source |
+ | * **Subzone** | ||
+ | * **Main source video** | ||
+ | ++++ | ||
- | Set the main output volume | + | ++++Read tuner frequency| |
+ | ++++ | ||
- | == Bass up selected output == | + | ++++Read tuner station| |
+ | ++++ | ||
- | Raise low frequencies for the selected output. | + | ++++Tuner frequency up| This command will allow to raise the tuner frequency. |
+ | ++++ | ||
- | == Bass down selected output == | + | ++++Tuner frequency |
+ | ++++ | ||
- | Lower low frequencies | + | ++++Tuner up| This command will allow to scan for the next tuner station. |
+ | ++++ | ||
- | == Treble up main output == | + | ++++Tuner down| This command will allow to scan for the previous tuner station. |
+ | ++++ | ||
- | Raise high frequencies for the main output. | + | ++++Tuner auto search| |
+ | ++++ | ||
- | == Treble down main output == | + | ++++Tuner stop search| |
+ | ++++ | ||
- | Lower high frequencies | + | ++++Select digital mode for main output| This command will allow to select the digital mode on the device. |
+ | * **Digital Mode** | ||
+ | ++++ | ||
- | == Move OSD cursor up == | + | ++++Select surround mode for main output| |
+ | * **Digital Mode** | ||
+ | ++++ | ||
- | Move OSD up | + | ++++Remote setup menu show/ |
+ | * **OSD Setup** 1=show OSD menu, 0=hide OSD menu. | ||
+ | ++++ | ||
- | == Move OSD cursor | + | ++++Remote press cursor |
+ | ++++ | ||
- | Move l’OSD | + | ++++Remote press cursor |
+ | ++++ | ||
- | == Move OSD cursor right == | + | ++++Remote press cursor right| This command will simulate the remote control command " |
+ | ++++ | ||
- | Move l’OSD right | + | ++++Remote press cursor left| This command will simulate the remote control command " |
+ | ++++ | ||
- | == Move OSD cursor left == | + | ++++Remote press Enter button| |
+ | ++++ | ||
- | Move l’OSD left | + | ++++Remote press Back/Return button| |
+ | ++++ | ||
- | == Select Source for main output == | + | ++++Remote press Option button| |
+ | ++++ | ||
- | Select source for the main output. | + | ++++Remote press Info button| |
- | + | ++++ | |
- | == Select audio source for selected main source == | + | |
- | + | ||
- | Select audio source for main source. | + | |
- | + | ||
- | == Select video source for selected main source == | + | |
- | + | ||
- | Select video source for main source. | + | |
- | + | ||
- | == Read tuner frequency == | + | |
- | + | ||
- | Read tuner frequency. | + | |
- | + | ||
- | == Read tuner station == | + | |
- | + | ||
- | Read tuner station. | + | |
- | + | ||
- | == Tuner Frequency up == | + | |
- | + | ||
- | Tuner frequency up. | + | |
- | + | ||
- | == Tuner Frequency down == | + | |
- | + | ||
- | Tuner frequency down. | + | |
- | + | ||
- | == Tuner Preset up == | + | |
- | + | ||
- | Change to next preset. | + | |
- | + | ||
- | == Tuner Preset down == | + | |
- | + | ||
- | Change to previous preset. | + | |
- | + | ||
- | == Tuner auto search == | + | |
- | + | ||
- | Tuner auto search. | + | |
- | + | ||
- | == Tuner stop sarch == | + | |
- | + | ||
- | Tuner stop search. | + | |
- | + | ||
- | == Press Enter button | + | |
- | + | ||
- | Press Enter button on OSD. | + | |
- | + | ||
- | == Select Digital mode for main output == | + | |
- | + | ||
- | Select digital mode for main output. | + | |
- | + | ||
- | == Select Surround mode for main output == | + | |
- | + | ||
- | Select surround mode for main output. | + | |
+ | ++++Send a custom command| | ||
+ | * **Command to send to the device** refer to the Denon/ | ||
+ | ++++ | ||
===== Sonos Zone Player (Obsolete) ===== | ===== Sonos Zone Player (Obsolete) ===== | ||
Line 1765: | Line 2254: | ||
Plays audio from a streaming webradio: the streaming url can be defined by adjusting the parameter on the right. | Plays audio from a streaming webradio: the streaming url can be defined by adjusting the parameter on the right. | ||
- | ===== Mediaplayer | + | ===== Media Player |
{{ : | {{ : | ||
Line 1781: | Line 2270: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Navigate up in the user interface | + | ++++ Navigate up in the user interface| Simulates the $\uparrow$ command. |
- | + | ++++ | |
- | Simulates the $\uparrow$ command. | + | |
- | + | ||
- | == Navigate down in the user interface == | + | |
- | + | ||
- | Simulates the $\downarrow$ command. | + | |
- | + | ||
- | == Navigate right in the user interface == | + | |
- | + | ||
- | Simulates the $\rightarrow$ command. | + | |
- | + | ||
- | == Navigate left in the user interface == | + | |
- | + | ||
- | Simulates the $\leftarrow$ command. | + | |
- | + | ||
- | == Select current item in the user interface == | + | |
- | + | ||
- | Select the current object in the user interface. (It simulates the ”OK” or ”Enter” command) | + | |
- | + | ||
- | == Goes back in the user interface == | + | |
- | + | ||
- | Return to the previous page; it simulates the ”Return” or ”Back” command. | + | |
- | + | ||
- | == Shows the context menu in the user interface == | + | |
- | + | ||
- | Visualise the current object menu; it simulates the ”Menu” button. | + | |
- | + | ||
- | == Shows the information dialogue == | + | |
- | + | ||
- | Displays a pop-up with the information related to the current program; it simulates the ”Info” button. | + | |
- | + | ||
- | == Goes to GUI homepage == | + | |
- | + | ||
- | Redirects to the GUI homepage; it simulates the ”Home” button. | + | |
- | + | ||
- | == Shows the on-screen display for the current player == | + | |
- | + | ||
- | Visualise a pop-up with the on-screen display for the current player. | + | |
- | + | ||
- | == Starts playback of a single file or an item from the database == | + | |
- | + | ||
- | Launches a specified file; the file path can be specified by adjusting the ”File path” parameter on the right. | + | |
- | + | ||
- | == Play/Pause the player == | + | |
- | + | ||
- | Play or pause the current player. | + | |
- | + | ||
- | == Stop the player == | + | |
- | + | ||
- | Stops the player. | + | |
- | + | ||
- | == Skip the current track and play the next one == | + | |
- | + | ||
- | Skips the current track and directly play the next one. | + | |
- | + | ||
- | == Skip the current track and play the previous one == | + | |
- | + | ||
- | Skips the current track and directly play the next one. | + | |
- | + | ||
- | == Make a step forward on the current playing element == | + | |
- | + | ||
- | Fast forward the current playing element. | + | |
- | + | ||
- | == Make a step backward on the current playing element == | + | |
- | + | ||
- | Fast backward the current playing element. | + | |
- | + | ||
- | == Raise the volume of the player == | + | |
- | + | ||
- | Turns the volume up. | + | |
- | + | ||
- | == Lower the volume of the player == | + | |
- | + | ||
- | Turns the volume down. | + | |
+ | ++++ Navigate down in the user interface | Simulates the $\downarrow$ command. | ||
+ | ++++ | ||
+ | ++++ Navigate right in the user interface | Simulates the $\rightarrow$ command. | ||
+ | ++++ | ||
+ | ++++ Navigate left in the user interface | Simulates the $\leftarrow$ command. | ||
+ | ++++ | ||
+ | ++++ Select current item in the user interface | Select the current object in the user interface. (It simulates the ”OK” or ”Enter” command) | ||
+ | ++++ | ||
+ | ++++ Goes back in the user interface | Return to the previous page; it simulates the ”Return” or ”Back” command. | ||
+ | ++++ | ||
+ | ++++ Shows the context menu in the user interface | Visualise the current object menu; it simulates the ”Menu” button. | ||
+ | ++++ | ||
+ | ++++ Shows the information dialogue | Displays a pop-up with the information related to the current program; it simulates the ”Info” button. | ||
+ | ++++ | ||
+ | ++++ Goes to GUI homepage | Redirects to the GUI homepage; it simulates the ”Home” button. | ||
+ | ++++ | ||
+ | ++++ Shows the on-screen display for the current player | Visualise a pop-up with the on-screen display for the current player. | ||
+ | ++++ | ||
+ | ++++ Starts playback of a single file or an item from the database | Launches a specified file; the file path can be specified by adjusting the ”File path” parameter on the right. | ||
+ | ++++ | ||
+ | ++++ Play/Pause the player | Play or pause the current player. | ||
+ | ++++ | ||
+ | ++++ Stop the player | Stops the player. | ||
+ | ++++ | ||
+ | ++++ Skip the current track and play the next one | Skips the current track and directly play the next one. | ||
+ | ++++ | ||
+ | ++++ Skip the current track and play the previous one | Skips the current track and directly play the next one. | ||
+ | ++++ | ||
+ | ++++ Make a step forward on the current playing element | Fast forward the current playing element. | ||
+ | ++++ | ||
+ | ++++ Make a step backward on the current playing element | Fast backward the current playing element. | ||
+ | ++++ | ||
+ | ++++ Raise the volume of the player | Turns the volume up. | ||
+ | ++++ | ||
+ | ++++ Lower the volume of the player | Turns the volume down. | ||
+ | ++++ | ||
===== Sonos Manager ===== | ===== Sonos Manager ===== | ||
Line 1862: | Line 2314: | ||
This object represents the complete integration of Sonos systems in ThinKnx, it allows to control and receive feedbacks from Sonos players directly through network without creating more traffic on KNX. In this way, all the commands and feedbacks can be available on KNX only if the installer really need them. | This object represents the complete integration of Sonos systems in ThinKnx, it allows to control and receive feedbacks from Sonos players directly through network without creating more traffic on KNX. In this way, all the commands and feedbacks can be available on KNX only if the installer really need them. | ||
+ | |||
+ | <WRAP important center align round 80%> This object is currently tested with Sonos S1 system. For more information on S2, contact our support team. </ | ||
* **Players** Sonos players configured in ThinKnx system. | * **Players** Sonos players configured in ThinKnx system. | ||
Line 1920: | Line 2374: | ||
Commands sent to the Sonos Player and recallable from other objects: | Commands sent to the Sonos Player and recallable from other objects: | ||
- | == Put the device in PLAY state == | + | ++++Put the device in PLAY state| This command will allow to play music on the selected player. |
+ | ++++ | ||
- | Allows | + | ++++Put the device in STOP state| |
+ | ++++ | ||
- | == Put the device | + | ++++Volume up the device| This command will allow to raise the volume on the selected player. |
+ | ++++ | ||
- | Allows | + | ++++Volume down the device| |
+ | ++++ | ||
- | == Volume up the device == | + | ++++Skip track forward| |
+ | ++++ | ||
- | Allows | + | ++++Skip track backward| |
+ | ++++ | ||
- | == Volume down the device == | + | ++++Set value for volume| |
+ | * **Desired Volume** value between 0 and 100. | ||
+ | ++++ | ||
- | Allows | + | ++++Put the device in MUTE state| |
+ | * **Mute value** 1=unmuted, 0=muted. | ||
+ | ++++ | ||
- | == Set value for volume == | + | ++++Play the audio from Audio IN plug| This command will allow to play the music coming from the analog input of the player. |
+ | ++++ | ||
- | Allows | + | ++++Play the audio from another player Audio IN plug| This command will allow to play the music coming from the analog input of another player player. |
+ | * **Zone player unique identifier** this identifier | ||
+ | ++++ | ||
- | == Skip track forward == | + | ++++Play the audio from a network file| This command will allow to play a shared file on the network using its URL. |
+ | * **File URL** should follow the form < | ||
+ | ++++ | ||
- | Allows to skip to the next track in the Sonos Player queue. | + | ++++Play |
+ | * **Streaming URL** should follow | ||
+ | ++++ | ||
- | == Skip track backward == | + | ++++Enable/ |
+ | * **Repeat value** 1=enabled, 0-disabled. | ||
+ | ++++ | ||
- | Allows to skip to the previous track in the Sonos Player queue. | + | ++++Enable/ |
+ | * **Shuffle value** 1=enabled, 0-disabled. | ||
+ | ++++ | ||
- | == Put the device in MUTE state == | + | ++++Start a Playlist from its number| |
+ | * **Playlist number** | ||
+ | ++++ | ||
- | Allows to set the Mute status on the Sonos Player; the parameter on the right indicates whether to Mute (1) or Unmute (0) the device. | + | ++++Start a Playlist from its name| This command will start playing a desired playlist from its name. |
+ | * **Playlist name** | ||
+ | ++++ | ||
- | == Play the audio from AUDIO-IN plug == | + | ++++Play a favorite item from its number| |
- | + | * **Favorite | |
- | Starts playing from Audio-in source. | + | ++++ |
- | + | ||
- | == Play the audio from another player’s AUDIO-IN plug == | + | |
- | + | ||
- | Starts playing from the Audio-in source of a different player; to specify the player adjust the parameter on the right specifying the unique identifier of the source player (refer to Sonos Player properties). | + | |
- | + | ||
- | == Play the audio from a network file == | + | |
- | + | ||
- | Starts playing from a network file source; the url of the file source must be adjusted in the parameter on the right, using the format // | + | |
- | + | ||
- | == Play the audio from a streaming == | + | |
- | + | ||
- | Starts playing from a streaming source; the streaming url must be adjusted in the parameter on the right, using the format // | + | |
- | + | ||
- | == Enable/ | + | |
- | + | ||
- | Allows to set the playing modality; the parameter on the right indicates whether to Enable (1) or Disable (0) the Repeat modality. | + | |
- | + | ||
- | == Enable/ | + | |
- | + | ||
- | Allows to set the playing modality; the parameter on the right indicates whether to Enable (1) or Disable (0) the Shuffle modality. | + | |
- | + | ||
- | == Start a playlist | + | |
- | + | ||
- | Recalls the playlist to play; the parameter on the right indicates the number of the desired playlist. | + | |
- | + | ||
- | == Start a playlist | + | |
- | + | ||
- | Recalls | + | |
- | + | ||
- | == Start a favorite from its number | + | |
- | + | ||
- | Recalls the favorite to play; the parameter on the right indicates the number of the desired favorite. This command only works if the favorite’s name in Sonos starts with “Num -” where Num is the number used to recall the favorite. | + | |
==== Sonos Topology commands ==== | ==== Sonos Topology commands ==== | ||
Line 2002: | Line 2449: | ||
This object allows to control an IR Transmitter device integrated into the LAN network. It can be interfaced with Ethernet, Ethernet PoE and Controller LAN devices. | This object allows to control an IR Transmitter device integrated into the LAN network. It can be interfaced with Ethernet, Ethernet PoE and Controller LAN devices. | ||
- | * **IR commands** List of IR commands, | + | * **IR commands** List of IR commands. Commands should be created manually in the IR Commands Editor. For each one, it is either possible to insert the code directly, or link it to an existing code from the imported database under " |
- | * **Remotes directory** This property allows to choose from a list of remotes | + | * **IR device model** Select the brand of the IR transmitter used. The user can choose between **IR Trans Transmitter** or **Global Caché Transmitter**. |
+ | * **Remotes directory** This property allows to import | ||
* **Copy in project** If this property is enabled, the system automatically saves the remotes files in the project folders. | * **Copy in project** If this property is enabled, the system automatically saves the remotes files in the project folders. | ||
* **Check for update** If this property is enabled, the system automatically checks if the remotes files are updated and immediately updates them if they are not. | * **Check for update** If this property is enabled, the system automatically checks if the remotes files are updated and immediately updates them if they are not. | ||
- | * **IP address** | + | * **IP address** IP address |
==== Adding IR commands ==== | ==== Adding IR commands ==== | ||
Line 2012: | Line 2460: | ||
Click on the button displayed on the right to open the actions editor window, click on ”Add” and adjust the properties in the grid: | Click on the button displayed on the right to open the actions editor window, click on ”Add” and adjust the properties in the grid: | ||
- | * **Alias** | + | |
- | * **Remote** | + | |
- | * **Command** Command | + | |
+ | === Manually add IR data === | ||
+ | * **Remote** | ||
+ | * **Command** Leave this field empty in case you have an IR code that you are adding manually. | ||
+ | * **Command | ||
- | ==== Importing and exporting | + | === Link command to an imported list === |
+ | <WRAP important round center 80%> It is important to have the remotes files saved into the remote directory selected previously. In case of a Global Caché remote file, please remove the extension " | ||
+ | * **Remote** Select the remote file available in the directory configured under " | ||
+ | * **Command** Select the IR command from the remote selected in the previous field. | ||
+ | * **Command Data** This data is automatically filled once the IR command is selected. | ||
+ | ==== Import/ | ||
This feature allows to export a list of IR commands previously created in a project and import it in another project. | This feature allows to export a list of IR commands previously created in a project and import it in another project. | ||
Line 2030: | Line 2487: | ||
Commands sent to the object and recallable from other objects: | Commands sent to the object and recallable from other objects: | ||
- | == Send the selected command for the selected remote | + | ++++Send the selected command for the selected remote| This command will allow to send an IR command |
- | + | ||
- | Allows | + | |
- | To create a sequence select the desired | + | |
{{ :: | {{ :: | ||
- | If you want to selected | + | If you want to select |
{{ :: | {{ :: | ||
It is possible to create complex macro of IR operations simply enqueuing more commands. Commands can be separated by pause adding the ”Make pause” item in order to grant a better reception. The sequence displayed in the box on the bottom of the page can be edited by deleting single items or moving them by clicking on ”Up” and ”Down” buttons. | It is possible to create complex macro of IR operations simply enqueuing more commands. Commands can be separated by pause adding the ”Make pause” item in order to grant a better reception. The sequence displayed in the box on the bottom of the page can be edited by deleting single items or moving them by clicking on ”Up” and ”Down” buttons. | ||
{{ :: | {{ :: | ||
+ | ++++ | ||
- | ===== Logic Module ===== | ||
- | {{ : | ||
- | This object represents a collection of block diagrams which allows you to build complex logics with a graphical editor. For more informations please refer to the [[logic_module|Logic Module section]]. | ||
- | * **Schemes** List of schemes, each element represents a fully working block diagram. | ||
- | ===== IFTTT ===== | ||
- | {{ : | ||
- | This object allows you to connect with IFTTT service to create automated tasks between a wide array of apps, services, and devices. For more information please refer to the [[ifttt|IFTTT section]]. | ||
- | * **Label** Text label to identify the object | ||
- | * **Webhook Key** Webhook key of the user account to use to communicate with IFTTT service. Can be obtained visiting this URL: < | ||
- | |||
- | ===== Voice Control Gateway ===== | ||
- | |||
- | {{ : | ||
- | |||
- | This object allows you to control the house by sending voice commands to your voice enabled device, whether it was via Siri (Apple Homekit), Alexa (Amazon Echo) or Google Assistant. For more information please refer to the [[voice_control|Voice Control Gateway section]]. | ||
- | |||
- | * **Label** Text label to identify the object | ||
- | * **Lights** Holds the collection of Light objects added | ||
- | * **Rollers Shutters** Holds the collection of Shutter objects added | ||
- | * **Thermo Comfort** Holds the collection of Thermo Comfort objects added | ||
- | * **Scenes** Holds the collection of Scene objects added |