Changed console command prefix to 'openhab' (#1281)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>pull/1282/head
Christoph Weitkamp
GitHub
parent
d92feddd3c
commit
9dbc6a989e
|
|
@ -24,97 +24,97 @@ Some of the described commands are executed on the internal database and could b
|
|||
Query an item's state:
|
||||
|
||||
```
|
||||
openhab> smarthome:status Heating_GF_Corridor
|
||||
openhab> openhab:status Heating_GF_Corridor
|
||||
OFF
|
||||
```
|
||||
|
||||
Changing an item's state:
|
||||
|
||||
```
|
||||
openhab> smarthome:send Heating_GF_Corridor ON
|
||||
openhab> openhab:send Heating_GF_Corridor ON
|
||||
Command has been sent successfully.
|
||||
```
|
||||
|
||||
Get help for a command:
|
||||
|
||||
```
|
||||
openhab> help smarthome:send
|
||||
Usage: smarthome:send <item> <command> - sends a command for an item
|
||||
openhab> help openhab:send
|
||||
Usage: openhab:send <item> <command> - sends a command for an item
|
||||
```
|
||||
|
||||
### Items
|
||||
|
||||
| Command | Description |
|
||||
|-------------------------------------|---------------------------------------------------------------------|
|
||||
| `smarthome:status <item>` | shows the current status of an item |
|
||||
| `smarthome:update <item> <state>` | sends a status update for an item |
|
||||
| `smarthome:send <item> <command>` | sends a command for an item |
|
||||
| `smarthome:items list [<pattern>]` | lists names and types of all items (matching the pattern, if given) |
|
||||
| `smarthome:items clear` | removes all items |
|
||||
| `smarthome:items remove <itemName>` | removes the given item |
|
||||
| Command | Description |
|
||||
|-----------------------------------|---------------------------------------------------------------------|
|
||||
| `openhab:status <item>` | shows the current status of an item |
|
||||
| `openhab:update <item> <state>` | sends a status update for an item |
|
||||
| `openhab:send <item> <command>` | sends a command for an item |
|
||||
| `openhab:items list [<pattern>]` | lists names and types of all items (matching the pattern, if given) |
|
||||
| `openhab:items clear` | removes all items |
|
||||
| `openhab:items remove <itemName>` | removes the given item |
|
||||
|
||||
### Discovery
|
||||
|
||||
| Command | Description |
|
||||
|--------------------------------------------------------|----------------------------------------------------------------------------|
|
||||
| `smarthome:discovery start <thingTypeUID!bindingID>` | runs a discovery on a given thing type or binding |
|
||||
| `smarthome:discovery enableBackgroundDiscovery <PID>` | enables background discovery for the discovery service with the given PID |
|
||||
| `smarthome:discovery disableBackgroundDiscovery <PID>` | disables background discovery for the discovery service with the given PID |
|
||||
| Command | Description |
|
||||
|------------------------------------------------------|----------------------------------------------------------------------------|
|
||||
| `openhab:discovery start <thingTypeUID!bindingID>` | runs a discovery on a given thing type or binding |
|
||||
| `openhab:discovery enableBackgroundDiscovery <PID>` | enables background discovery for the discovery service with the given PID |
|
||||
| `openhab:discovery disableBackgroundDiscovery <PID>` | disables background discovery for the discovery service with the given PID |
|
||||
|
||||
### Inbox
|
||||
|
||||
| Command | Description |
|
||||
|----------------------------------------------|------------------------------------|
|
||||
| `smarthome:inbox` | lists all current inbox entries |
|
||||
| `smarthome:inbox listignored` | lists all ignored inbox entries |
|
||||
| `smarthome:inbox approve <thingUID> <label>` | creates a thing for an inbox entry |
|
||||
| `smarthome:inbox clear` | clears all current inbox entries |
|
||||
| `smarthome:inbox ignore <thingUID>` | ignores an inbox entry permanently |
|
||||
| Command | Description |
|
||||
|--------------------------------------------|------------------------------------|
|
||||
| `openhab:inbox` | lists all current inbox entries |
|
||||
| `openhab:inbox listignored` | lists all ignored inbox entries |
|
||||
| `openhab:inbox approve <thingUID> <label>` | creates a thing for an inbox entry |
|
||||
| `openhab:inbox clear` | clears all current inbox entries |
|
||||
| `openhab:inbox ignore <thingUID>` | ignores an inbox entry permanently |
|
||||
|
||||
### Things
|
||||
|
||||
| Command | Description |
|
||||
|--------------------------|----------------------------|
|
||||
| `smarthome:things list` | lists all things |
|
||||
| `smarthome:things clear` | removes all managed things |
|
||||
| Command | Description |
|
||||
|------------------------|----------------------------|
|
||||
| `openhab:things list` | lists all things |
|
||||
| `openhab:things clear` | removes all managed things |
|
||||
|
||||
### Links
|
||||
|
||||
| Command | Description |
|
||||
|-----------------------------------------------------------|--------------------------------|
|
||||
| `smarthome:links list` | lists all links |
|
||||
| `smarthome:links addChannelLink <itemName> <channelUID>` | links an item with a channel |
|
||||
| `smarthome:links removeChannelLink <itemName> <thingUID>` | unlinks an item with a channel |
|
||||
| `smarthome:links clear` | removes all managed links |
|
||||
| Command | Description |
|
||||
|---------------------------------------------------------|--------------------------------|
|
||||
| `openhab:links list` | lists all links |
|
||||
| `openhab:links addChannelLink <itemName> <channelUID>` | links an item with a channel |
|
||||
| `openhab:links removeChannelLink <itemName> <thingUID>` | unlinks an item with a channel |
|
||||
| `openhab:links clear` | removes all managed links |
|
||||
|
||||
### Audio
|
||||
|
||||
| Command | Description |
|
||||
|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
|
||||
| `smarthome:audio play [<sink>] <filename>` | plays a sound file from the `$OPENHAB_CONF/sounds` folder through the optionally specified audio sink(s) |
|
||||
| `smarthome:audio play <sink> <filename> <volume>` | plays a sound file from the `$OPENHAB_CONF/sounds` folder through the specified audio sink(s) with the specified volume |
|
||||
| `smarthome:audio stream [<sink>] <url>` | streams the sound from the url through the optionally specified audio sink(s) |
|
||||
| `smarthome:audio sources` | lists the audio sources |
|
||||
| `smarthome:audio sinks` | lists the audio sinks |
|
||||
| Command | Description |
|
||||
|-------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
|
||||
| `openhab:audio play [<sink>] <filename>` | plays a sound file from the `$OPENHAB_CONF/sounds` folder through the optionally specified audio sink(s) |
|
||||
| `openhab:audio play <sink> <filename> <volume>` | plays a sound file from the `$OPENHAB_CONF/sounds` folder through the specified audio sink(s) with the specified volume |
|
||||
| `openhab:audio stream [<sink>] <url>` | streams the sound from the url through the optionally specified audio sink(s) |
|
||||
| `openhab:audio sources` | lists the audio sources |
|
||||
| `openhab:audio sinks` | lists the audio sinks |
|
||||
|
||||
### Voice
|
||||
|
||||
| Command | Description |
|
||||
|---------------------------------------|------------------------------------------------------------------------|
|
||||
| `smarthome:voice say <text>` | speaks a text on the default audio sink with the default TTS and voice |
|
||||
| `smarthome:voice voices` | lists available voices of the active TTS services |
|
||||
| `smarthome:voice interpret <command>` | interprets a human language command |
|
||||
| Command | Description |
|
||||
|-------------------------------------|------------------------------------------------------------------------|
|
||||
| `openhab:voice say <text>` | speaks a text on the default audio sink with the default TTS and voice |
|
||||
| `openhab:voice voices` | lists available voices of the active TTS services |
|
||||
| `openhab:voice interpret <command>` | interprets a human language command |
|
||||
|
||||
### Automation
|
||||
|
||||
| Command | Description |
|
||||
|----------------------------------------|-----------------------------------------------------------|
|
||||
| `smarthome:script <script to execute>` | Executes a script from the `$OPENHAB_CONF/scripts` folder |
|
||||
| Command | Description |
|
||||
|--------------------------------------|-----------------------------------------------------------|
|
||||
| `openhab:script <script to execute>` | Executes a script from the `$OPENHAB_CONF/scripts` folder |
|
||||
|
||||
### Firmware
|
||||
|
||||
| Command | Description |
|
||||
|-----------------------------------------------------------|-------------------------------------------------|
|
||||
| `smarthome:firmware list <thingTypeUID>` | Lists the available firmwares for a thing type. |
|
||||
| `smarthome:firmware status <thingUID>` | lists the firmware status for a thing |
|
||||
| `smarthome:firmware update <thingUID> <firmware version>` | updates the firmware for a thing |
|
||||
| Command | Description |
|
||||
|---------------------------------------------------------|-------------------------------------------------|
|
||||
| `openhab:firmware list <thingTypeUID>` | Lists the available firmwares for a thing type. |
|
||||
| `openhab:firmware status <thingUID>` | lists the firmware status for a thing |
|
||||
| `openhab:firmware update <thingUID> <firmware version>` | updates the firmware for a thing |
|
||||
|
|
|
|||
Loading…
Reference in New Issue