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

[Documentation] Markdown improvements f to m (#13866)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-08 21:36:05 +01:00
committed by GitHub
parent 3c236b3103
commit 0e68936663
122 changed files with 3490 additions and 3662 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
bundles/org.openhab.binding.mycroft/README.md
View File

@@ -12,7 +12,6 @@ Possibilies include:
- React to all the aforementioned events ...
- ... and send/receive any other kind of messages on the message bus
## Supported Things
The only thing managed by this binding is a Mycroft instance
@@ -21,19 +20,16 @@ The only thing managed by this binding is a Mycroft instance
|--------------------|----------------------------------------------------------------------------|
| mycroft | A Mark I/II, a Picroft, or any other variant exposing the message bus |
## Discovery
There is no discovery service, as Mycroft doesn't announce itself on the network.
## Thing Configuration
The configuration is simple, as you just need to give the IP/hostname of the Mycroft instance accessible on the network.
The default port is 8181, which can be changed.
```
```java
Thing mycroft:mycroft:myMycroft "Mycroft A.I." @ "Living Room" [host="192.168.X.X"]
```
@@ -43,12 +39,10 @@ Thing mycroft:mycroft:myMycroft "Mycroft A.I." @ "Living Room" [host="192.168.X.
| port | integer | Port to reach Mycroft (default 8181) | No |
| volume_restoration_level | integer | When unmuted, force Mycroft to restore volume to this value | No |
## Channels
A Mycroft thing has the following channels:
| channel type id | Item type | description |
|------------------------------|-----------|------------------------------------------------------------------------------------------------|
| listen | Switch | Switch to ON when Mycroft is listening. Can simulate a wake word detection to trigger the STT |
@@ -59,14 +53,12 @@ A Mycroft thing has the following channels:
| volume | Dimmer | The volume of the Mycroft speaker. (Note : Value unreliable until a volume change occured) |
| full_message | String | The last message (full json) seen on the Mycroft Bus. Filtered by the messageTypes properties |
The channel 'full_message' has the following configuration available:
| property | type | description | mandatory |
|---------------|---------------------------------|-------------------------------------------------------------------------|-----------|
| messageTypes | List of string, comma separated | Only these message types will be forwarded to the Full Message Channel | No |
## Full Example
A manual setup through a `things/mycroft.things` file could look like this:
@@ -98,7 +90,7 @@ String myMycroft_fullmessage "Full JSON message" { channel="my
A `demo.sitemap` file:
```
```perl
sitemap demo label="myMycroft"
{
Frame label="myMycroft" {
@@ -113,7 +105,6 @@ sitemap demo label="myMycroft"
}
```
### Ask Mycroft to say something
mycroft.rules