GEN 2 - Master - Command Line Interface

The Gateway has 2 computer systems built-in: A Master Controller (Microchip 18F67J11 based) and a Gateway Controller (Linux Based Beagle Bone Black). The Master controller is connected with the Gateway Controller over RS232. The Master Controller has a built-in CLI interface allowing the user to configure and control the Master controller to his full extend.

This CLI can be accessed by using the Maintenance function in the Renson Smart Living cloud or by using a RS232 TTL cable (Baud rate 115200, 8 databits, no parity, 1 stop bit, no flow control) that is connected directly on the Gateway (the necessary jumpers needs to be removed to work properly see RS232)

Possible modes of communication:

• Advanced Mode: API (The Master controller and Gateway controller will use Advanced mode to communicate)

• Simple Mode: CLI (Simple Mode will be used by Maintenance mode in the cloud or when a direct RS232 connection is established)

Notes

1. In CLI mode, characters sent through RS232 can be echoed (“echo on” or “echo off”). In API mode they are never echoed.

2. Instructions are case sensitive.

3. As opposed to API mode, CLI mode has a variable instruction length.

4. Every instruction must be followed by a Carriage return (<CR>, DEC 13).

5. Every successful instruction will return the requested information (or perform requested action) followed by OK, otherwise ERROR is returned (wrong format, wrong parameters,…). All error codes are listed in the Error Codes section.

6. An instruction will only be executed if the Master has responded with “OK”

7. To go from CLI to API mode type exit. To go from API to CLI mode type STRCM (capitals), followed by random characters until “ERROR 17” or “OK” appears.

8. As of V3.143.3, some instructions that are rarely used have been removed to free up space flash memory of the microcontroller. All these instruction still can be done or by using "basic action activate ..." or by writing directly to eeprom, see Memory Model. Following instruction must be used to write to eeprom:

• "eeprom write ..."

• "eeprom activate"

Notation

Instruction [required parameter] {optional parameter}

Instruction description.

[param]Parameter description

Returns

[return value]

Versioning

This document describes the available CLI commands available on the Gateway Module CLI interface.

Instruction Set

Action instructions

action read [action] [bank]

Instruction removed since firmware version 3.143.3

Gets the values stored for a simple action.

[action]

Number of the action, a maximum of 204 (0 - 203) simple actions can be defined

[bank]

Always use 0

Returns

[config byte] [selected output or validation bit nr] [timer] [dimmer]

Example:

action read 5 0 will read simple action 5 of bank 0

output: 10 35 8000 40

In this example, simple action 5 will toggle (config byte=10) output 35 with timer value 8000 (if toggled on) and dimmer value 40 (if toggled on)

Notes:

1. For description of the config byte, please see Config Types page

2. Only bank 0 works in the current firmware version. Writing and reading in all banks is possible, however, activating these simple actions (except for bank 0) are not possible

3. Only use simple actions when no basic actions exist to execute the requested function. Before using simple actions, first look at the Action Types document for existing Basic Actions

action write [action] [bank] [config byte] [output or validation bit number] [timer] [dimmer]

Instruction removed since firmware version 3.143.3

Sets a simple action in the eeprom.

[action]

Number of the action, a maximum of 204 (0 - 203) simple actions can be defined per bank.

[bank]

Always use 0

[config byte]

The action byte of the instruction.

[output / validation]

The output or validation bit number to which the instruction is written.

[timer]

Dimmer level, ranging from 0 to 63.

[dimmer]

Timer value in seconds, ranging from 0 to 65500.

Example:

action write 6 0 9 12 10000 45 will write simple action 6 in bank 0: put output 12 on with specific timer value (config byte=9) of 10000 seconds and with a light intensity of 45 (max 63).

Notes:

1. For description of the config byte, please see Config Types document

2. Only bank 0 works in the current firmware version. Writing and reading in all banks is possible, however, activating these simple actions (except for bank 0) are not possible

3. Only use simple actions when no basic actions exist to execute the requested function. Before using simple actions, first look at the Action Types document for existing Basic Actions

action activate [action] [bank]

Instruction removed since firmware version 3.143.3

Activates a simple action. Always use this function to test a created simple action.

[action]

Number of the action, a maximum of 204 (0 - 203) simple actions can be defined per bank.

[bank]

Number of the bank, there are 4 (0 - 3) banks available.

Example:

action activate 6 0 will run action 6 of bank 0.

API equivalent: STRIFA6 0

Note:

1. Only bank 0 works in the current firmware version. Writing and reading in all banks is possible, however, activating these simple actions (except for bank 0) are not possible

action name write [action] [action name]

Instruction removed since firmware version 3.143.3

Sets the action name (description) for a specified action. For every simple action, a free text of maximum 16 characters can be programmed. This text will make it easier to identify the use of every simple action.

[action]

Number of the action.

[action name]

Description of the simple action, with a maximum of 16 characters.

Example:

action name write 3 Test action will program name “Test action” for Simple Action 3.

action list

Instruction removed since firmware version 3.143.3

Lists all active actions, and their corresponding action name (if the first byte of an action is < 255, then the action is active). For every Simple Action, a free text of maximum 16 characters can be programmed. This text will make it easier to identify the use of every simple action.

Returns

[action] [action name]

[action] [action name]

[action] [action name]

etc

add virtual module [virtual type]

This instruction will add a virtual module.

[virtual type]

This is the type of virtual module to be added. These are the virtual modules that can be added: "o"-> Virtual Output, "d"-> Virtual Dimmer, "r"-> Virtual Roller Shutter, "i"-> Virtual Input.

Returns

OK

automatic response read

Instruction removed since firmware version 3.143.3

Gets the automatic response (AR) value which indicates if automatic sends are allowed in API mode.

Returns

[AR]

• AR = 255: the system will not automatically report changes in output status

• AR < 255: the system will automatically report all changes in output status (through response “RO”)

automatic response write [AR]

Instruction removed since firmware version 3.143.3

Sets the automatic response (AR) value which indicates if automatic sends (to computer) are allowed in API mode.

[AR]

• AR = 255: the system will not automatically report changes in output status

• AR < 255: the system will automatically report all changes in output status (through response “RO”)

basic action activate [action type] [action number]

Activates a Basic Action defined in the action type list (see the Action Types page). With this instruction, any action (simple action, group action, schedule action or any other) can be executed. Use this instruction to test your Basic Actions.

[action type]

Action type of the action to be executed as defined in the Action Types.

[action number]

action number to be activated.

Example:

basic action activate 172 10 will switch on all lights of group 10.

API equivalent: STRIFQ172 10

brightness read [module]

Instruction removed since firmware version 3.143.3

This instruction will read the brightness from modules that can connect a LDR (light sensitive resistor).

[module]

Number of the module.

Returns

[brightness]

The brightness value, ranging from 0 to 254.

• 0: Maximum light intensity

• 254: Minimum light intensity

• 255: Sensor not connected

Example:

Brightness read 1

output: 245

Notes:

1. When a sensor is not connected, the system returns Sensor not connected.

2. Some input modules with older firmware versions will give value 0 for light intensity even when no sensor is connected.

brightness list

Returns a list with all modules and their corresponding brightness value.

Returns

[module] [brightness]

Example:

brightness list

output:

00 Sensor not connected

01 245

02 Sensor not connected

can control erase [instruction] [ID0] [ID1] [ID2] [ID3]

This instruction can partially or fully reset the CAN Control module

[ID0..3]

These are the addresses (4 bytes) of the CAN Control module

[instruction]

Instruction ranging from 0 to 2

Instruction=0 -> Fully erase CAN Control = Factory Reset, all inputs and sensors connected to the CAN control will be forgotten. It will need to be removed & re-added to the system

Instruction=1 -> Erase inputs = all inputs connected to the CAN Control will be erased

Instruction=2 -> Erase sensors = all sensors connected to the CAN Control wil be erased

Example:

can control erase 0 67 15 20 231

Notes:

1. The address of the CAN Control can be easily found in the "error list"

2. When a full erase is executed, the Master will respond with errors since the module isn't reachable anymore, this is expected behaviour and the input list should be adapted by using instruction "input number modules write x"

3. This instruction communicates directly with the RS485 bus and will not generate an error if the ID's are used of a non existing module.

4. If Instruction=0 is used, a full erase will be executed including the virtual modules made. If Instruction=1 or 2, the created virtual modules are kept.

5. If instruction=0 is used, the CAN Control that gets this factory reset will switch on all LEDs until the erase is finished.

6. In order to completely erase the CAN control module without having to remove/re-add it to the system use instruction 1 followed by instruction 2

cli mode read

Instruction removed since firmware version 3.143.3

Gets the CLI mode value which indicates in what mode the Master will start (or after instruction “eeprom activate” or any instruction using “eeprom activate”).

Returns

[cli mode]

• cli mode = 255: the Master will start up in CLI mode

• cli mode < 255: the Master will start up in API mode

cli mode write [cli mode]

Instruction removed since firmware version 3.143.3

Sets the CLI mode value which indicates in what mode the Master will start (or after instruction “eeprom activate” or any instruction using “eeprom activate”).

[cli mode]

• cli mode = 255: the Master will start up in CLI mode

• cli mode < 255: the Master will start up in API mode

current setpoint read [thermostat]

Gets the currently set temperature setpoint of a certain thermostat. The system has built-in thermostat functions, in total 24 different thermostats (0 - 23) can be activated. Every thermostat can drive 2 outputs; these outputs can be dimmer outputs (electronic valve 0 - 10V) or a relay outputs (or a combination of both).

[thermostat]

Number of the thermostat, ranging from 0 to 23.

Returns

[thermostat] [temperature]

Example:

current setpoint read 5 Reads the set temperature for thermostat 5.

output: 05 +22.0

current setpoint write [thermostat] [setpoint]

Sets the current setpoint temperature of an individual thermostat. Setpoint represents the desired temperature. The Master has built-in thermostat functions, in total 24 different thermostats (0 - 23) can be activated. Every thermostat can drive 2 outputs; these outputs can be a dimmer outputs (electronic valve 0 - 10V) or a relay outputs (or a combination of both). Every thermostat can have 6 preprogrammed temperature setpoints (0-5).

[thermostat]

Number of the thermostat, ranging from 0 to 23.

[setpoint]

Number of the setpoint value, ranging from 0 to 5.

Example:

current setpoint write 5 22.0

Notes:

1. The setpoint temperature must include a 0 or 5 after the decimal or the instruction will return an error. current setpoint write 5 22.0 is correct, while current setpoint write 5 22 is not.

date write [date] [month] [year]

Sets the time into the system.

[date]

Date (1-31)

[month]

Month (1-12)

[year]

Year (0-99)

Example:

date write 30 1 22 will write the current date (30-01-22).

Notes:

1. When the battery is connected (jumper is set), even when the power is disconnected, the time, Thermostat setpoints and the light status will be kept in the real time clock RAM memory.

debug on

Enables debug mode. In debug mode, the Master will send multiple messages of the different states and activities while the Master is executing different tasks. Changing the status of the debug mode will not influence the programmed eeprom setting for debugging (see “Memory Model” eeprom, page 0) which is used as a standard startup value.

This function will also enable output debug (od) information telling which function in the system changed the output. More information regarding the od code can be found in the appendixes (D).

Notes:

1. Enabling debug mode will decrease the performance of the system. Only use debug mode for throuble shooting.

debug off

Disables debug mode. Changing the status of the debug mode will not influence the programmed eeprom setting for debugging (see “Memory Model” eeprom, page 0) which is used as a standard startup value.

decision read [decision]

Instruction removed since firmware version 3.143.3

This instruction will read the programmed functions in a simple decision. In the system, maximum 192 (0-191) simple decisions can be programmed. For more information about simple decisions, please refer to the document “Memory Model”.

[decision]

Number of the decision.

Returns

[decision byte] [datafield1(IF)] [datafield2(IF)] [datafield3(IF)] [action type(THEN)] [action(THEN)] [action type(ELSE)] [action(ELSE)]

Example:

decision read 14 will read simple decision 14

output: 4 10 0 3 0 14 255 255

In this example, when input 10 is pressed (decision byte = 4) for 3 seconds (datafield 2 will be ignored in this example), simple action 14 (action type = 0) will be activated. ELSE is ignored ( = 255) in this example.

Notes:

1. For the description of the decision byte, please see the Decision Types page. For the description of the action type byte, please see the Action Types page.

2. Only use simple decisions when the basic actions IF THEN ELSE ENDIF can’t do the job. Please refer to the Action Types page for the different Basic Actions that exist.

decision write [decision] [decision byte] [datafield1 (IF)] [datafield2 (IF)] [datafield3 (IF)] [action type (THEN)] [action (THEN)] [action type (ELSE)] [action (ELSE)]

Instruction removed since firmware version 3.143.3

Sets the necessary bytes for a simple decision. In the system, maximum 192 (0-191) simple decisions can be programmed. For more information about simple decisions, please refer to the document “Memory Model”.

[decision][decision byte][datafield1 (IF)][datafield2 (IF)][datafield3 (IF)][action type (THEN)][action number (THEN)][action type (ELSE)][action number (ELSE)]

Example:

decision write 15 0 10 0 1 2 5 0 10 will create a simple decision 15 that, if activated, will check output (decision byte = 0) 10 if high (= 1) will activate group action (action type = 2) 5, if not will activate simple action (action type = 0) 10.

decision write 16 18 2 0 1 178 2 5 0 10 will create a simple decision 16 that, if activated, will check temperature of module 2, if temperature is higher (18) then 178 (>25 °C -> (178-128)/2, see temperature table and calculation) will activate group action (action type = 2) 5, if not will activate simple action (action type=0) 10.

Notes:

1. For the description of the decision byte, please see the Decision Types page. For the description of the action type byte, please see the Action Types page.

2. Only use simple decisions when the basic actions IF THEN ELSE ENDIF can’t do the job. Please refer to the Action Types page for the different Basic Actions that exist.

3. In simple decisions, the system value must be used to indicate the temperature.

4. Brightness is stored in the system as a decimal value between 1 and 255 for every input module (every input module can have maximum one brightness sensor). If brightness = 1: complete darkness, if brightness = 255: maximum light, if brightness = 0: brightness sensor not connected.

5. Temperature (°C) is stored in System Value format

decision activate [decision]

Instruction removed since firmware version 3.143.3

Execute a simple decision. Use this instruction to test your simple decisions.

[decision]

Number of the decision.

Example:

decision activate 29 will execute decision 29.

API equivalent: STRIFD14

decision name write [decision] [decision name]

Instruction removed since firmware version 3.143.3

Sets the name (description) for a specified decision. For every simple decision, a free text of maximum 16 characters can be programmed. This text will make it easier to identify the use of every simple decision.

[decision]

Number of the decision.

[decision name]

Description of the decision, with a maximum of 16 characters.

Example:

decision name write 29 decision Liv1 will program decision Liv1 as name for simple decision 29.

decision list

Instruction removed since firmware version 3.143.3

Lists all active decisions, and their corresponding name (if the first byte of a decision is < 255, then the decision is active).

Returns

[decision] [decision name]

[decision] [decision name]

[decision] [decision name]

etc

dimmer step read

Instruction removed since firmware version 3.143.3

Gets the dimmer step. Dimmer step: every cycle (scan), when dimming up or down, the dimmer value will be increased or decreased with the dimmer step (ie: dim down: new dimmer value = current dimmer value – dimmer step until minimum light level is achieved).

Returns

[dimmer step]

Dimmer step ranges from 1 to 10

Example:

dimmer step read

output: 2

Notes:

1. If the corresponding eeprom value (which is read with this instruction) is 255, the system will take 1 as the standard value for dimmer step.

dimmer step write [dimmer step]

Instruction removed since firmware version 3.143.3

Sets the dimmer step. Dimmer step: every cycle (scan), when dimming up or down, the dimmer value will be increased or decreased with the dimmer step (ie: dim down: new dimmer value = current dimmer value – dimmer step until minimum light level is achieved).

[dimmer step]

The dimmer step value, ranging from 1 to 10

dimmer minimum read

Instruction removed since firmware version 3.143.3

Gets the dimmer minimum. Dimmer minimum is the lowest level that can be reached when dimming down (ie: the lowest light level).

Returns

[dimmer minimum]

Dimmer minimum, ranging from 0 (off) to 62

Example:

immer minimum read

output: 6

Notes:

1. If the corresponding eeprom value (which is read with this instruction) is 255, the system will take 5 as the standard value for dimmer minimum.

dimmer minimum write [dimmer minimum]

Instruction removed since firmware version 3.143.3

Sets the dimmer minimum. Dimmer minimum is the lowest level that can be reached when dimming down (ie: the lowest light level).

[dimmer minimum]

Dimmer minimum, ranging from 0 (off) to 62.

dimmer cycle read

Instruction removed since firmware version 3.143.3

Gets the dimmer cycle. This value specifies the number of scanning cycles of the input module before it starts dimming. With dimmer cycle = 8: if the associated button is pressed for less than 8 scanning cycles the light will go on/off. When pressed for more than 8 scanning cycles the light will start dimming.

Returns

[dimmer cycle]

Dimmer cycle, ranging from 2 to 63

Example:

dimmer cycle read

output: 6

Notes:

1. If the corresponding eeprom value (which is read with this instruction) is 255, the system will take 7 as the standard value for dimmer cycle. Dimmer cycle wait cycles are closely related with the value Wait Cycles (see “wait cycles read/write”).

dimmer cycle write [dimmer cycle]

Instruction removed since firmware version 3.143.3

Sets the dimmer cycle. This value specifies the number of scanning cycles of the input module before it starts dimming.

[dimmer cycle]

Dimmer cycle, ranging from 2 to 63.

dimmer memory read

Instruction removed since firmware version 3.143.3

Gets the dimmer memory. When the returned value is 0, the light will always switch on at full intensity (when not used in special function), when this byte is higher than 0, the last value in memory will be used.

Returns

[dimmer memory]

Dimmer memory, 0 or 1

Example:

dimmer memory read

output: 1

dimmer memory write [dimmer memory]

Instruction removed since firmware version 3.143.3

Sets the dimmer memory. When the returned value is 0, the light will always switch on at full intensity (when not used in special function), when this byte is higher than 0, the last value in memory will be used.

[dimmer memory]

Dimmer memory, 0 or 1

discover can control [can control nr]

This instruction allows, for CAN Controls already initialised (by using the init button), to remotely start the discover mode and have all new virtual input and output modules added without having the typically push the init button. Since this instruction will put all module in discovery mode, the module discover stop instruction have to be executed.

[can control nr]

CAN Control number, value from 1 to 4

If you only have 1 CAN Control, the CAN Control nr=1. If you have multiple CAN Controls, their number can be determined by the "error list" command. The first CAN control in the list is nr 1, the second is nr 2, etc.

echo on

All characters sent through RS232 will be echoed. This instruction will program this setting in eeprom.

echo off

All characters sent through RS232 will not be echoed. This instruction will program this setting in eeprom.

eeprom read [page] [byte]

Gets the value from the eeprom at the specified page and byte (For the eeprom memory layout, please use the document Memory Model). The installed eeprom has 256 (0-255) pages of 256 (0-255) bytes.

[page]

Page in the eeprom, ranging from 0 to 255.

[byte]

Byte nr in the eeprom, ranging from 0 to 255.

Example:

eeprom read 0 6 will read the value in the eeprom on page 0 row 6

eeprom write [page] [byte] [value]

Sets the value in the eeprom at the specified page and row (For the eeprom memory layout, please use the document Memory Model). The installed eeprom has 256 (0-255) pages of 256 (0-255) bytes.

[page]

Page in the eeprom, ranging from 0 to 255.

[Byte]

Byte nr in the eeprom, ranging from 0 to 255.

[value]

Decimal value to be written.

Example:

eeprom write 0 6 15 will write the decimal value 15 in the eeprom on page 0 row 6

Notes:

1. After eeprom write the command eeprom activate must be used to validate changes.

eeprom activate

Many values are copied from eeprom into RAM to increase the speed of the system. If values are written in the eeprom by using the instruction “eeprom write” it is necessary to copy eeprom data into RAM by using this instruction. For more information regarding the eeprom values, please see the document Memory Model

error list

Returns a list with all input and output modules and their error state. The MASTER polls every module several times per second. Each module must respond promptly to the MASTER requests. With this instruction, the number of communication errors for each module can be displayed. If a module is not responding in time or not responding at all, the number of errors for that module will increase. The maximum errors that the system will record is 65.000 for each module.

Example:

error list

output:

00 I 066.244.122.189 0 No Errors

01 I 066.030.015.135 0 C No Errors

02 I 066.047.023.139 0 # of Errors: 44

03 I 073.062.031.015 1 # of Errors: 100

04 I 073.212.106.053 0 No Errors

05 B 066.040.148.074 0 No Errors

00 O 079.083.041.148 0 No Errors

01 D 068.151.047.095 0 No Errors

02 D 068.190.124.249 0 No Errors

03 O 079.243.231.207 0 No Errors

04 C 067.188.022.098 0 C No Errors

The first value indicate the module number, the letter is the module type, the four following values are the module address followed by the Offline modus (0 or 1) which indicated if the module is offline (=1) or not (=0). In the above example, Input module 3 is offline. See also Memory Model page 0 byte 29.

In this example, Input module “I” with ID 66.47.23.139 has 44 communication errors and Input module 3 has 100 Errors and has been taken offline. To bring a module back online, please use instruction error clear.

In this example, you can also see that input module 01 is a CAN module since the "C" appears just before the number of errors.

Notes:

1. To clear all errors, use error clear.

error clear

Clears all errors in the system.

exit

Switches from Simple Mode (CLI) to Advanced Mode (API). When used, debug mode will always be turned off.

firmware version

Gets the current firmware version.

floor level read [output]

A series of lights can be grouped together and can, for example, be switched on or off together.

Gets the floor level (or group) associated with the indicated output.

Returns

[FL]

floor level write [output] [FL]

Sets the floor level (FL) or group associated with the indicated output. A series of lights can be grouped together and can, for example, be switched on or off together.

[output]

output between 0 and 239

[FL]

Floor level or group between 0 and 254 (255 is no group, selecting 255 will select all lights)

group read [group action]

A group action consist of max 16 Basic Actions. This instruction returns the programmed Basic Actions (simple actions, group actions, simple decisions etc) in this group action. In the system, 160 (0-159) group actions can be defined. Each group action consist of maximum 16 (0-15) actions. Actions can be cascaded; a group action can call other group actions to create bigger group actions. See Action Types for the different Basic Actions.

[group]

Number of the group action.

Returns

[line] [action type] [action number]

Example:

group read 4 will read all actions defined in group action 4

output:

00 009 015

01 000 005

02 002 000

03 255 255

…

14 255 255

15 255 255

In this example, when group action 4 is called, this group action will call simple decision 15 (action type = 9), simple action 5 (action byte = 0) and group action 0 (action type = 2).

Notes:

1. Once 255 is reached in the list, the processor will not continue to read the list. If we would include a Basic Action on line 13, this action would not be activated. For the description of the Basic Actions, please see Action Types page.

2. Following groups are used by the OLED display (if used): group 140->Home (Aut), Group 141->Away, group 142->Lights off, group 143->Sleep, group 144->Sphere 1, group 145->Sphere 2 and group 146->Sphere 3

group write [group] [line] [action type] [action number]

A group action consists of max 16 Basic Actions. This instruction will program Basic Actions (simple actions, group actions, simple decisions etc.) in the selected group action. In the system, 160 (0-159) group actions can be defined. Each group action consist of maximum 16 (0-15) Basic Actions. Actions can be cascaded; a group action can call other group actions to create bigger group actions.

[group]

Number of the group action.

[line]

Number of the line.

[action type]

Type of action.

[action number]

Number of the action.

Example:

group write 4 3 0 12 will add in group action 4 on line 3 simple action (action type = 0) 12.

Notes:

1. Once 255 is reached in the list, the processor will not continue to read the list. If we would include a Basic Action on line 13, this action would not be activated. For the description of the Basic actions, please see the Action Types page.

2. Following groups are used by the OLED display (if used): group 140->Home, Group 141->Away, group 142->Lights off, group 143->Sleep, group 144->Sphere 1, group 145->Sphere 2 and group 146->Sphere 3, group 147 -> Vacation, group 148 -> Party

group activate [group]

Activates (runs) the selected group action.

[group]

Number of the group action to activate.

Example:

group activate 4 will run group 4.

API equivalent: STRIFG4

group name write [group] [group name]

Sets the group name (description) for a specific group action. For every group action, a free text of maximum 16 characters can be programmed. This text will make it easier to identify the use of every group action.

[group]

Number of the group.

[group name]

Description of the group, with a maximum of 16 characters.

Example:

group name write 4 Liv all off will program the group name “Liv all off” for group action 4.

group list

Lists all active group actions, and their corresponding text (if the first byte of an action is < 255, then the action is active). For every simple action, a free text of maximum 16 characters can be programmed. This text will it make easier to identify the use of every group action.

Returns

[group] [group name]

[group] [group name]

[group] [group name]

…

humidity read [sensor]

Instruction removed since firmware version 3.143.3

Reads the humidity of the connected sensors. There are input/sensor modules that can measure air humidity.

[sensor]

Number of the sensor (0-31).

Returns

[sensor] [humidity]

Humidity is displayed in %RH (Relative Humidity) and is the relative humidity with calculated temperature compensation.

Example:

humidity read 1 reads humidity of sensor number 1

output: 01 41.5%RH

Notes:

1. Humidity is stored in System Value format

Notes:

1. When a sensor is not connected, the system returns Sensor not connected

2. In the advanced communication protocol, the system value is sent, not the calculated humidity.

3. When using a Basic Action (for example IF THEN ELSE ENDIF), system values are always used.

humidity list

Returns a list with all input/sensor modules and their corresponding relative humidity (with temperature compensation).

Returns

[sensor] [humidity]

Humidity is displayed in %RH (Relative Humidity) and is the relative humidity with calculated temperature compensation

Example:

humidity list

output:

00 Sensor not connected

01 41.5%RH

02 Sensor not connected

input indicate [input]

This instruction will make the input led of the corresponding input blink during 20 seconds. This is a usefull function to find back a certain input without changing the state of that input. Please note that this instruction will only work on input modules with an individual input status led and when the module is running in Normal Mode (not in Module discovery mode).

[input]

Number of the input

input invert read [input]

Reads the invert status of an input. Standard inputs are NO (Normally Open). It is however possible to connect NC (Normally closed) switches. This instruction will indicate if the input is configured as NO (displayed as 1) or configured as NC (dispayed as 0). Standard, all inputs are configured as NO.

Returns

[invert status]

Example:

input invert read 29 will read the invert status of input 29.

output: 0

Switch 29 is not inverted and configured as NC.

Notes:

1. CLI instruction input list will also show the programmed invert status of all inputs

input invert write [input] [invert status]

Writes the invert status of an input. Standard inputs are NO (Normally Open). It is however possible to connect NC (Normally closed) switches. This instruction will program if the input is configured as NO (displayed as 1) or configured as NC (dispayed as 0). Standard, all inputs are configured as NO.

[input]

Number of the input

[invert status]

"0" for NC, "1" for NO

Example:

input invert write 29 1 will program input 29 as a NO input

input link read [input]

Reads the output action for the selected input. Every input has a corresponding output (or intelligent action). With this instruction, you can read which output has been programmed for the requested input.

Returns

[input name] -> [output] [output name]

Following output actions are possible (for more details, please see document “Memory Model”):

• 0-239: Toggle one selected output from 0 to 239 (default timer values are used)

• 240: perform intelligent action (basic actions of the input page are executed)

• 241: All outputs off

• 242: All lights off

• 255: Do nothing

Example:

input link read 29 will read the action for input 29.

output:

18: Switch29 -> Kitchen

Switch 29 will toggle output 18 with name “Kitchen”

input link list

Returns a list with all the input links programmed for all the inputs installed.

Returns

[input] [input name] -> [output] [output name]

[input] [input name] -> [output] [output name]

[input] [input name] -> [output] [output name]

…

Following output actions are possible (for more details, please see document “Memory Model”):

• 0-239: Toggle one selected output from 0 to 239 (default timer values are used)

• 240: perform intelligent action (basic actions of the input page are executed)

• 241: All outputs off

• 242: All lights off

• 255: Do nothing

Example:

input link list (With only 1 input module (8 inputs) installed)

output:

000 Button0 -> 002 Kitchen

001 Button1 -> 255 No Function

002 All Off -> 240 Special Function

003 Button3 -> 019 Bedroom 1

004 Button4 -> 020 Bedroom 2

005 Button5 -> 021 Bedroom 3

006 Button6 -> 016 Living

007 But LIV1 -> 016 Living

Notes:

1. In this example, every input and output has a programmed name. Unnamed inputs/outputs are automatically named No Name or Empty.

input link write [input] [output action]

Sets the output action that is triggered when an input (button) is activated. 2 sorts of output actions are possible: toggle an output or perform an intelligent action. If a toggle function (output 0-239) must be performed, the required output must be selected and programmed in the link byte by using this instruction.

[input]

Number of the input

[output action]

Following output actions are possible (for more details, please see document “Memory Model”):

• 0-239: Toggle one selected output from 0 to 239 (default timer values are used)

• 240: perform intelligent action

• 241: All outputs off

• 242: All lights off

• 255: Do nothing

Example:

input link write 29 14 will toggle output 14 when input 29 is activated

input action read [input]

Returns the input list with all programmed Basic actions. Every input has an input list which can contain up to 15 Basic Actions. The programmed Basic Actions will only be activated when the input link byte is set at 240. See the Action Types for the different Basic Action.

Returns

[input link byte]

[line number] [action type] [action number]

repeated 15 times

The returned information is the input link byte followed by 15 (0-14) lines with the action type and the action number.

Example:

input action read 14 will read all the intelligent actions including the link byte of input 14

output:

240

00 009 015

01 000 005

02 255 255

“03 255 255

…

13 255 255

14 255 255

In this example, simple decision 15 (with action type: 9) and action 5 (with action type: 0) will be called when input 14 is activated.

Notes:

1. Once 255 is reached in the list, the Master will not continue to read the list. If we would include a simple action on line 13, this action would not be activated. For the description of the action type byte, please see Action Types page.

input action write [input] [line number] [action type] [action number]

Sets a Basic Action for a specific input. Every input has an input list that can contain up to 15 Basic Actions. The programmed Basic Actions will only be activated when the input link byte is set at 240. See Action Types for the different basic actions

[input]

Number of the input.

[line number]

Line number of the input action list.

[action type]

Action type to set.

[action number]

Action number to set.

Example:

input action write 14 2 0 6 will write simple action (action type=0) 6 on line 2 of the input action list of input 14.

Notes:

1. Once 255 is reached in the list, the processor will not continue to read the list. If we would include a simple action on line 13, this action would not be activated. For the description of the action type byte, please see the Action Types page.

2. For more information on input specific configuration, please refer to document “Memory Model”.

input address read [module number]

Instruction removed since firmware version 3.143.3

Gets the address of the selected input module from the Master. Every input module has his own network address. With this instruction, you can read the network address of a specific input module which is programmed in the Eeprom of the Master.

[module number]

Number of the input module.

Returns

[ID0].[ID1].[ID2].[ID3]

ID0 is the module type (73 = Input module)

ID1.ID2.ID3 is the unique network address.

Example:

input address read 1 will read the address of input module 1

output: 73.83.42.148

input address write [module number] [ID0] [ID1] [ID2] [ID3]

Instruction removed since firmware version 3.143.3

Every input module has his own network address. With this instruction, you can write the network address of a specific input module in the eeprom of the master, this will however not overwrite the network address of which is programmed in the module itself (the network address in the module will remain unchanged)!

[module number]

Number of the module.

[ID0]

Module type (73 = Input module)

[ID1][ID2][ID3]

Unique network address

Example:

input address write 1 73.83.42.149 will write the address of input module 1

Notes:

1. Writing the input address by using this instruction will not change the number of activated inputs (instead use input number modules write).

input address list

Instruction removed since firmware version 3.143.3

Gets all the addresses of the activated inputs.

The number of activated inputs can be checked with the instruction “input number modules read”.

Returns

[module number] [ID0].[ID1].[ID2].[ID3]

ID0 is the module type (73 = Input module)

ID1.ID2.ID3 is the unique network address.

Example:

output address list

output:

00 73.83.41.148

01 73.122.15.12

input number modules read

Gets the number of activated input modules. If the number of activated outputs is 3 for example, the system will use the first 3 output modules in its list even if more modules have been programmed in the input modules list.

Returns

[number of modules]

The number of activated input modules.

Example:

input number modules read

output: 3

input number modules write [number of modules]

Sets the number of activated inputs.

[number of modules]

The number of input modules to activate.

Example:

input number modules write 4 will change the number of activated input modules to 4.

input debug on

Set the system in input debug. While the system is in input debug mode, every time a switch is pressed, the system we indicate which input is pressed and which output is linked to this input.

Example:

input debug on

output: (when for example input 0 is pressed)

input pressed=0 selected output=16

Notes:

1. See also debug on

input debug off

Disables the input debug mode. While the system is in input debug mode, every time a switch is pressed, the system we indicate which input is pressed and which output is linked to this input.

Example:

input debug off

Notes:

1. See also debug off

input list

Returns a list of all available inputs with their corresponding invert status, output number and output ASCII name. Inputs which have not yet been added in discovery mode (by the “module discover start” instruction) will not appear even though they are connected.

Returns

[input] [Press/release state] ([invert status]) [input name] -> [output]

The ASCII string returned for output names has a maximum length of 8 characters. Unnamed inputs are displayed as “Empty”. The invert status will indicate if the input is configured as NO (normally open-> 1) or NC (Normally Closed -> 0). In the below example, input 2 is pressed and input 4 is programmed as Normally closed.

Example:

input list

output:

000 0 (1) input 0 -> 005

001 0 (1) But 1 -> 006

002 1 (1) But 2 -> 255

003 0 (1) Empty -> 255

004 0 (0) Empty -> 14

005 0 (1) But Kit -> 240

006 0 (1) Empty -> 255

007 0 (1) Empty -> 255