public
/
openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix console command documentation (#9355) 

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>
This commit is contained in:
J-N-K 2020-12-13 09:19:51 +01:00 committed by GitHub
parent fcad4826a6
commit 086a046b61
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bundles/org.openhab.binding.digitalstrom/README.md
View File

@ -79,7 +79,7 @@ The discovery also will discover all called scenes, if they aren't automatically
Temperature control scenes, like *eco* will be ignored, so they cannot be discovered. Temperature control scenes, like *eco* will be ignored, so they cannot be discovered.
If you only want to discover one of the thing types, you can start a discovery scan on the thing type you want to have discovered. If you only want to discover one of the thing types, you can start a discovery scan on the thing type you want to have discovered.
You can use the command line command, e.g.: ``smarthome:discovery start digitalstrom:namedScene`` to start the scan. You can use the command line command, e.g.: ``openhab:discovery start digitalstrom:namedScene`` to start the scan.
Which thing types this binding supports, please have a look at **Supported Things**. Which thing types this binding supports, please have a look at **Supported Things**.
## Thing Configuration and Properties ## Thing Configuration and Properties

12
bundles/org.openhab.binding.gardena/README.md
View File

@ -95,16 +95,16 @@ Number WC_Valve_cmd_Duration "Command Duration [%d min]" { channel=
Switch WC_Valve_cmd_OpenWithDuration "Watering Timer [%d min]" { channel="gardena:water_control:home:myWateringComputer:valve_commands#start_seconds_to_override" } Switch WC_Valve_cmd_OpenWithDuration "Watering Timer [%d min]" { channel="gardena:water_control:home:myWateringComputer:valve_commands#start_seconds_to_override" }
Switch WC_Valve_cmd_CloseValve "Stop Switch" { channel="gardena:water_control:home:myWateringComputer:valve_commands#stop_until_next_task" } Switch WC_Valve_cmd_CloseValve "Stop Switch" { channel="gardena:water_control:home:myWateringComputer:valve_commands#stop_until_next_task" }
smarthome:status WC_Valve_Duration // returns the duration of the last watering request if still active, or 0 openhab:status WC_Valve_Duration // returns the duration of the last watering request if still active, or 0
smarthome:status WC_Valve_Activity // returns the current valve activity (CLOSED|MANUAL_WATERING|SCHEDULED_WATERING) openhab:status WC_Valve_Activity // returns the current valve activity (CLOSED|MANUAL_WATERING|SCHEDULED_WATERING)
``` ```
All channels are read-only, except the command group and the lastUpdate timestamp All channels are read-only, except the command group and the lastUpdate timestamp
``` ```
smarthome:send WC_Valve_cmd_Duration.sendCommand(10) // set the duration for the command to 10min openhab:send WC_Valve_cmd_Duration.sendCommand(10) // set the duration for the command to 10min
smarthome:send WC_Valve_cmd_OpenWithDuration.sendCommand(ON) // start watering openhab:send WC_Valve_cmd_OpenWithDuration.sendCommand(ON) // start watering
smarthome:send WC_Valve_cmd_CloseValve.sendCommand(ON) // stop any active watering openhabsend WC_Valve_cmd_CloseValve.sendCommand(ON) // stop any active watering
``` ```
If you send a REFRESH command to the last update timestamp (no matter which thing), **ALL** items from **ALL** things are updated If you send a REFRESH command to the last update timestamp (no matter which thing), **ALL** items from **ALL** things are updated
@ -112,7 +112,7 @@ If you send a REFRESH command to the last update timestamp (no matter which thin
DateTime LastUpdate "LastUpdate [%1$td.%1$tm.%1$tY %1$tH:%1$tM]" { channel="gardena:water_control:home:myWateringComputer:common#lastUpdate_timestamp" } DateTime LastUpdate "LastUpdate [%1$td.%1$tm.%1$tY %1$tH:%1$tM]" { channel="gardena:water_control:home:myWateringComputer:common#lastUpdate_timestamp" }
// refresh ALL items // refresh ALL items
smarthome:send LastUpdate REFRESH openhab:send LastUpdate REFRESH
``` ```
### Debugging and Tracing ### Debugging and Tracing

4
bundles/org.openhab.binding.homematic/README.md
View File

@ -521,7 +521,7 @@ Display_CombinedParam.sendCommand("{DDBC=WHITE,DDTC=BLACK,DDI=0,DDA=CENTER,DDS=J
If you want to use the combined parameter in the console, you have to use ' instead of ", to prevent evaluation of curly braces: If you want to use the combined parameter in the console, you have to use ' instead of ", to prevent evaluation of curly braces:
```shell ```shell
smarthome:send Display_CombinedParam '{DDBC=WHITE,DDTC=BLACK,DDI=0,DDA=CENTER,DDS=Just a test,DDID=3,DDC=true}' openhab:send Display_CombinedParam '{DDBC=WHITE,DDTC=BLACK,DDI=0,DDA=CENTER,DDS=Just a test,DDID=3,DDC=true}'
``` ```
**Key translation:** **Key translation:**
@ -662,7 +662,7 @@ E.g you have an item linked to a variable with the name `Var_1`.
In the console: In the console:
```shell ```shell
smarthome:send Var_1 REFRESH openhab:send Var_1 REFRESH
``` ```
In scripts: In scripts:

2
bundles/org.openhab.binding.magentatv/README.md
View File

@ -85,7 +85,7 @@ There are different ways to setup the User ID:
Run the following command on the console and provide your Telekom account credentials: Run the following command on the console and provide your Telekom account credentials:
``` ```
openhab> smarthome:magentatv login openhab> openhab:magentatv login
Username (email): mail@example.com Username (email): mail@example.com
Password: topsecret Password: topsecret

2
bundles/org.openhab.binding.miio/README.base.md
View File

@ -185,7 +185,7 @@ All devices have available the following channels (marked as advanced) besides t
| actions#rpc | String | send commands via cloud. see below | | actions#rpc | String | send commands via cloud. see below |
note: the ADVANCED `actions#commands` and `actions#rpc` channels can be used to send commands that are not automated via the binding. This is available for all devices note: the ADVANCED `actions#commands` and `actions#rpc` channels can be used to send commands that are not automated via the binding. This is available for all devices
e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would enable a pre-configured timer. See https://github.com/marcelrv/XiaomiRobotVacuumProtocol for all known available commands. e.g. `openhab:send actionCommand 'upd_timer["1498595904821", "on"]'` would enable a pre-configured timer. See https://github.com/marcelrv/XiaomiRobotVacuumProtocol for all known available commands.
!!!channelList !!!channelList

2
bundles/org.openhab.binding.miio/README.md
View File

@ -448,7 +448,7 @@ All devices have available the following channels (marked as advanced) besides t
| actions#rpc | String | send commands via cloud. see below | | actions#rpc | String | send commands via cloud. see below |
note: the ADVANCED `actions#commands` and `actions#rpc` channels can be used to send commands that are not automated via the binding. This is available for all devices note: the ADVANCED `actions#commands` and `actions#rpc` channels can be used to send commands that are not automated via the binding. This is available for all devices
e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would enable a pre-configured timer. See https://github.com/marcelrv/XiaomiRobotVacuumProtocol for all known available commands. e.g. `openhab:send actionCommand 'upd_timer["1498595904821", "on"]'` would enable a pre-configured timer. See https://github.com/marcelrv/XiaomiRobotVacuumProtocol for all known available commands.
### Mi PM2.5 Air Quality Monitor (<a name="zhimi-airmonitor-v1">zhimi.airmonitor.v1</a>) Channels ### Mi PM2.5 Air Quality Monitor (<a name="zhimi-airmonitor-v1">zhimi.airmonitor.v1</a>) Channels

2
bundles/org.openhab.binding.tesla/README.md
View File

@ -34,7 +34,7 @@ There are two different ways of obtaining the token:
Run the following command on the console and provide your Tesla account credentials (the same that you use in the official Tesla app): Run the following command on the console and provide your Tesla account credentials (the same that you use in the official Tesla app):
``` ```
openhab> smarthome:tesla login openhab> openhab:tesla login
Username (email): mail@example.com Username (email): mail@example.com
Password: topsecret Password: topsecret
Attempting login...Attempting login... Attempting login...Attempting login...

6
bundles/org.openhab.io.homekit/README.md
View File

@ -574,7 +574,7 @@ If you register an IP address that isn't reachable from your phone (such as `loc
HomeKit allows only a single pairing to be established with the bridge. HomeKit allows only a single pairing to be established with the bridge.
This pairing is normally shared across devices via iCloud. This pairing is normally shared across devices via iCloud.
If you need to establish a new pairing, you will need to clear the existing pairings. If you need to establish a new pairing, you will need to clear the existing pairings.
To do this, you can issue the command `smarthome:homekit clearPairings` from the [OSGi console](https://www.openhab.org/docs/administration/console.html). To do this, you can issue the command `openhab:homekit clearPairings` from the [OSGi console](https://www.openhab.org/docs/administration/console.html).
After doing this, you may need to remove the file `$OPENHAB_USERDATA/jsondb/homekit.json` and restart openHAB. After doing this, you may need to remove the file `$OPENHAB_USERDATA/jsondb/homekit.json` and restart openHAB.
HomeKit requires a unique identifier for each accessory advertised by the bridge. HomeKit requires a unique identifier for each accessory advertised by the bridge.
@ -597,7 +597,7 @@ openhab> log:tail io.github.hapjava
## Console commands ## Console commands
`smarthome:homekit list` - list all HomeKit accessories currently advertised to the HomeKit clients. `openhab:homekit list` - list all HomeKit accessories currently advertised to the HomeKit clients.
`smarthome:homekit show <accessory_id | name>` - print additional details of the accessories which partially match provided ID or name. `openhab:homekit show <accessory_id | name>` - print additional details of the accessories which partially match provided ID or name.