From: M Valla <12682715+mvalla@users.noreply.github.com> Date: Sun, 18 Sep 2022 15:24:39 +0000 (+0200) Subject: [openwebnet] improved README for AUX and ENERGY (#13408) X-Git-Url: https://git.basschouten.com/?a=commitdiff_plain;h=e8d20f034175f8f19cced53f6e72152de1fa8b9e;p=openhab-addons.git [openwebnet] improved README for AUX and ENERGY (#13408) Signed-off-by: Massimo Valla Signed-off-by: Massimo Valla --- diff --git a/bundles/org.openhab.binding.openwebnet/README.md b/bundles/org.openhab.binding.openwebnet/README.md index 70658a2a83..dd76f85812 100644 --- a/bundles/org.openhab.binding.openwebnet/README.md +++ b/bundles/org.openhab.binding.openwebnet/README.md @@ -47,7 +47,7 @@ The following Things and OpenWebNet `WHOs` are supported: | Auxiliary (AUX) | `9` | `bus_aux` | AUX commands | Successfully tested: AUX configured for bulgrar-alarm unit 3486. Only sending AUX commands is supported | | CEN & CEN+ Scenarios | `15` & `25` | `bus_cen_scenario_control`, `bus_cenplus_scenario_control` | CEN/CEN+ scenarios events and virtual activation | Successfully tested: scenario buttons: HC/HD/HS/L/N/NT4680 | | Dry Contact and IR Interfaces | `25` | `bus_dry_contact_ir` | Dry Contacts and IR Interfaces | Successfully tested: contact interfaces F428 and 3477; IR sensors: HC/HD/HS/L/N/NT4610 | -| Energy Management | `18` | `bus_energy_meter` | Energy Management | Successfully tested: F520, F521 | +| Energy Management | `18` | `bus_energy_meter` | Energy Management | Successfully tested: F520, F521. Partially tested: F522, F523 | ### For ZigBee (Radio) @@ -126,12 +126,14 @@ For any manually added device, you must configure: - the associated gateway Thing (`Parent Bridge` menu) - the `where` configuration parameter (`OpenWebNet Address`): this is the OpenWebNet address configured for the device in the BTicino/Legrand system. This address can be found either on the device itself (Physical configuration, using jumpers in case of BUS) or through the MyHOME_Suite software (Virtual configuration). The address can have several formats depending on the device/system: - - example for BUS/SCS system, address Point-to-point with Area (A) and Light-point (PL): + - example for BUS/SCS system: - light device A=`2` (Area 2), PL=`4` (Light-point 4) --> `where="24"` - - light device A=`03`, PL=`11` on local bus --> `where="0311#4#01"` + - light device A=`03`, PL=`11` on local bus `01` --> `where="0311#4#01"` - CEN scenario A=`05`, PL=`12` --> `where="0512"` - - CEN+ scenario `5`: add a `2` before --> `where="25"` - - Dry Contact or IR Interface `99`: add a `3` before --> `where="399"` + - CEN+ scenario `5`: add `2` before --> `where="25"` + - Dry Contact or IR Interface `99`: add `3` before --> `where="399"` + - Energy meter F520/F521 numbered `1`: add `5` before --> `where="51"` + - Energy meter F522/F523 numbered `4` add `7` before and `#0` after --> `where="74#0"` - example for ZigBee devices: `where=765432101#9`. The ID of the device (ADDR part) is usually written in hexadecimal on the device itself, for example `ID 0074CBB1`: convert to decimal (`7654321`) and add `01#9` at the end to obtain `where=765432101#9`. For 2-unit switch devices (`zb_on_off_switch2u`), last part should be `00#9`. @@ -155,18 +157,36 @@ The (optional) Central Unit can be configured defining a `bus_themo_cu` Thing. #### Configuring Auxiliary (AUX) -BUS Auxiliary commands (WHO=9) can be used to send on the BUS commands to control, for example, external devices or a BTcino Alarm system. +**NOTE** Receiving AUX messages originating from the BUS is not supported yet, only sending messages to the BUS is supported. -To control a BTicino alarm system the alarm unit should be configured for example as follows: +BUS Auxiliary commands (WHO=9) can be used to send on the BUS commands to control, for example, external devices or a BTicino Alarm system. -Antitheft -> Automations -> then toggle the Event option -> then select OPEN code +The BTicino Alarm system **cannot** be controlled directly via the OpenWebNet protocol: the only possibility is to use AUX commands and configure your Alarm Control Panel (Automations section) to execute some commands (e.g. Activate alarm) when it receives a particular AUX OpenWebNet command. +Alarm Control Automations allow you to run an OpenWebNet command when a particular event occurs; in this case, the events are changes of state of the AUX device (WHO=9) and the command to be performed is a burglar alarm command (WHO=5). -- Type in the AUX command you want to set, e.g.\*9\*1\*4\## (where=4) -- Type in the associated Open Web Net code you want to execute, e.g.\*5\*8*#1234## (engage alarm on zones 1,2,3,4). +To configure Alarm Control Automations go to the menu: -Please note that receiving AUX messages originating from the bus is not supported yet, only sending messages to the bus is supported. + Antitheft -> Automations +##### Example configuration Automation 1: when AUX-1 goes OFF, then DISENGAGE all Zones +With this configuration when AUX `where=1` goes OFF, the Alarm will execute the automantion and send command `*5*9##` to DISENGAGE all zones. + + Name: Disengage all zones + Event: command OPEN = `*9*0*1##` + OPEN command to execute: `*5*9##` + +##### Example configuration Automation 2: when AUX-2 goes ON, then ENGAGE active Zones + + Name: Engage active zones + Event: command OPEN = *9*1*2## + OPEN command to execute: *5*8## + +##### Example configuration Automation 3: when AUX-4 goes ON, then ENGAGE Zones 1, 2, 3, 4 + + Name: Engage zones 1-4 + Event: command OPEN = *9*1*4## + OPEN command to execute: *5*8#1234## ### Central Unit integration missing points @@ -183,10 +203,10 @@ Please note that receiving AUX messages originating from the bus is not supporte | `switch` or `switch_01`/`02` for ZigBee | `bus_on_off_switch`, `zb_on_off_switch`, `zb_on_off_switch2u` | Switch | To switch the device `ON` and `OFF` | R/W | | `brightness` | `bus_dimmer`, `zb_dimmer` | Dimmer | To adjust the brightness value (Percent, `ON`, `OFF`) | R/W | | `shutter` | `bus_automation` | Rollershutter | To activate roller shutters (`UP`, `DOWN`, `STOP`, Percent - [see Shutter position](#shutter-position)) | R/W | -| `button#X`   | `bus_cen_scenario_control`, `bus_cenplus_scenario_control` | String | Trigger channel for CEN/CEN+ scenario events [see possible values](#cen-cen-channels) | R (TRIGGER) | +| `button#X` | `bus_cen_scenario_control`, `bus_cenplus_scenario_control` | String | Trigger channel for CEN/CEN+ scenario events [see possible values](#cen-cen-channels) | R (TRIGGER) | | `sensor` | `bus_dry_contact_ir` | Switch | Indicates if a Dry Contact Interface is `ON`/`OFF`, or if a IR Sensor is detecting movement (`ON`), or not (`OFF`) | R | | `power` | `bus_energy_meter` | Number:Power | The current active power usage from Energy Meter | R | -| `aux` | `bus_aux` | String | Possible commands: ON,OFF,TOGGLE, STOP, UP,DOWN,ENABLED, DISABLED, RESET_GEN, RESET_BI, RESET_TRI. Only 'ON' and `OFF' are supported for now | R/W | +| `aux` | `bus_aux` | String | Possible commands: `ON`, `OFF`, `TOGGLE`, `STOP`, `UP`, `DOWN`, `ENABLED`, `DISABLED`, `RESET_GEN`, `RESET_BI`, `RESET_TRI`. Only `ON` and `OFF` are supported for now | R/W | ### Thermo channels @@ -204,7 +224,7 @@ Please note that receiving AUX messages originating from the bus is not supporte | `remoteControl` | `bus_thermo_cu` | String | The Central Unit Remote Control status: `ENABLED`, `DISABLED` | R | Y | | `batteryStatus` | `bus_thermo_cu` | String | The Central Unit Battery status: `OK`, `KO` | R | Y | | `weeklyProgram` | `bus_thermo_cu` | Number | The program number (`1`, `2`, `3`) when Central Unit mode is `WEEKLY` | R/W | N | -| `scenarioProgram` | `bus_thermo_cu` | Number | The program number (`1`, `2`, .. , `16`) when Central Unit mode is `SCENARIO` | R/W | N | +| `scenarioProgram` | `bus_thermo_cu` | Number | The program number (`1`, `2`, ... , `16`) when Central Unit mode is `SCENARIO` | R/W | N | | `failureDiscovered` | `bus_thermo_cu` | Switch | Indicates if a Failure was discovered by the Central Unit: `ON`, `OFF` | R | Y | | `atLeastOneProbeOff` | `bus_thermo_cu` | Switch | Indicates if at least one probe is in OFF mode: `ON`, `OFF` | R | Y | | `atLeastOneProbeProtection` | `bus_thermo_cu` | Switch | Indicates if at least one probe is in PROTECTION mode: `ON`, `OFF` | R | Y |