Skip to content

Commit

Permalink
[Documentation] Markdown improvements f to m (openhab#13866)
Browse files Browse the repository at this point in the history 
Signed-off-by: Jerome Luckenbach <[email protected]>
Signed-off-by: Andras Uhrin <[email protected]>
  • Loading branch information
@Confectrician @andrasU
Confectrician authored and andrasU committed Jan 5, 2024
1 parent 8f3c7b1 commit abc627f
Show file tree
Hide file tree
Showing 39 changed files with 2,387 additions and 2,236 deletions.
4 changes: 2 additions & 2 deletions bundles/org.openhab.binding.flicbutton/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ demo.things:

```java
Bridge flicbutton:flicd-bridge:local-flicd {
Thing button flic_livingroom "Yellow Button Living Room" [address = "60:13:B3:02:18:BD"]
Thing button flic_kitchen "Black Button Kitchen" [address = "B5:7E:59:78:86:9F"]
Thing button flic_livingroom "Yellow Button Living Room" [address = "60:13:B3:02:18:BD"]
Thing button flic_kitchen "Black Button Kitchen" [address = "B5:7E:59:78:86:9F"]
}
```

Expand Down
2,158 changes: 1,079 additions & 1,079 deletions bundles/org.openhab.binding.fmiweather/README.md
View file

Large diffs are not rendered by default.

103 changes: 42 additions & 61 deletions bundles/org.openhab.binding.folderwatcher/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,99 +1,80 @@
# FolderWatcher Binding

This binding is intended to monitor a local folder, FTP and S3 bucket and their subfolders and notify of new files.
This binding is intended to monitor FTP and local folder and its subfolders and notify of new files

## Supported Things

The binding support three types of things: `localfolder`, `ftpfolder` and `s3bucket`.
Currently the binding support two types of things: `ftpfolder` and `localfolder`.

## Thing Configuration

The `localfolder` thing has the following configuration options:
The `ftpfolder` thing has the following configuration options:

| Parameter | Name | Description | Required | Default value |
| ------------------ | --------------------------- | ----------------------------------- | -------- | ------------- |
| localDir | Local Directory | Local directory to be watched | yes | n/a |
| listHiddenLocal | List Hidden | Allow listing of hidden files | yes | No |
| pollIntervalLocal | Polling interval in seconds | Interval for polling folder changes | yes | 60 |
| listRecursiveLocal | List Sub Folders | Allow listing of sub folders | yes | No |
| Parameter | Name | Description | Required | Default value |
|-------------|--------------|------------------------------------------------------------------------------------------------------------------------|----------|---------------|
| ftpAddress | FTP server | IP address of FTP server | yes | n/a |
| ftpPort | FTP port | Port of FTP server | yes | 21 |
| secureMode | FTP Security | FTP Security | yes | None |
| ftpUsername | Username | FTP user name | yes | n/a |
| ftpPassword | Password | FTP password | yes | n/a |
| ftpDir | RootDir | Root directory to be watched | yes | n/a |
| listRecursiveFtp | List Sub Folders | Allow listing of sub folders | yes | No |
| listHidden | List Hidden | Allow listing of hidden files | yes | false |
| connectionTimeout | Connection timeout, s | Connection timeout for FTP request | yes | 30 |
| pollInterval | Polling interval, s | Interval for polling folder changes | yes | 60 |
| diffHours | Time stamp difference, h | How many hours back to analyze | yes | 24 |

The `ftpfolder` thing has the following configuration options:
The `localfolder` thing has the following configuration options:

| Parameter | Name | Description | Required | Default value |
|-------------|--------------|------------------------------------------------------------------------------------------------------------------------|----------|---------------|
| localDir | Local Directory | Local directory to be watched | yes | n/a |
| listHiddenLocal | List Hidden | Allow listing of hidden files | yes | No |
| pollIntervalLocal | Polling interval, s | Interval for polling folder changes | yes | 60 |
| listRecursiveLocal | List Sub Folders | Allow listing of sub folders | yes | No |

| Parameter | Name | Description | Required | Default value |
| ----------------- | ------------------------------ | ----------------------------------- | -------- | ------------- |
| ftpAddress | FTP server | IP address of FTP server | yes | n/a |
| ftpPort | FTP port | Port of FTP server | yes | 21 |
| secureMode | FTP Security | FTP Security | yes | None |
| ftpUsername | Username | FTP user name | yes | n/a |
| ftpPassword | Password | FTP password | yes | n/a |
| ftpDir | RootDir | Root directory to be watched | yes | n/a |
| listRecursiveFtp | List Sub Folders | Allow listing of sub folders | yes | No |
| listHidden | List Hidden | Allow listing of hidden files | yes | false |
| connectionTimeout | Connection timeout in seconds | Connection timeout for FTP request | yes | 30 |
| pollInterval | Polling interval in seconds | Interval for polling folder changes | yes | 60 |
| diffHours | Time stamp difference in hours | How many hours back to analyze | yes | 24 |

The `s3bucket` thing has the following configuration options:

| Parameter | Name | Description | Required | Default value |
|----------------|----------------------|----------------------------------------------------|----------|---------------|
| s3BucketName | S3 Bucket Name | Name of the S3 bucket to be watched | yes | n/a |
| s3Path | S3 Path | S3 path (folder) to be monitored | no | n/a |
| pollIntervalS3 | Polling Interval | Interval for polling S3 bucket changes, in seconds | yes | 60 |
| awsKey | AWS Access Key | AWS access key | no | n/a |
| awsSecret | AWS Secret | AWS secret | no | n/a |
| awsRegion | AWS Region | AWS region of S3 bucket | yes | "" |
| s3Anonymous | Anonymous Connection | Connect anonymously (works for public buckets) | yes | true |
## Events

This binding supports the following event:
This binding currently supports the following events:

| Channel Type ID | Item Type | Description |
|-----------------|-----------|----------------------------|
| newfile | String | A new file name discovered |
| Channel Type ID | Item Type | Description |
|-----------------|--------------|----------------------------------------------------------------------------------------|
| newftpfile | String | A new file name discovered on FTP |
| newlocalfile | String | A new file name discovered on in local folder |

## Full Example

Thing configuration:

```java
folderwatcher:localfolder:myLocalFolder [ localDir="/myfolder", pollIntervalLocal=60, listHiddenLocal="false", listRecursiveLocal="false" ]
folderwatcher:ftpfolder:myLocalFolder [ ftpAddress="X.X.X.X", ftpPort=21, secureMode="EXPLICIT", ftpUsername="username", ftpPassword="password", ftpDir="/myfolder/", listHidden="true", listRecursiveFtp="true", connectionTimeout=33, pollInterval=66, diffHours=25 ]
folderwatcher:s3bucket:myS3bucket [ s3BucketName="mypublic-bucket", pollIntervalS3=60, awsRegion="us-west-1", s3Anonymous="true" ]

folderwatcher:ftpfolder:myLocalFolder [ ftpAddress="X.X.X.X", ftpPort=21, secureMode="EXPLICIT", ftpUsername="username", ftpPassword="password",ftpDir="/myfolder/",listHidden="true",listRecursiveFtp="true",connectionTimeout=33,pollInterval=66,diffHours=25]
```

### Using in a rule:

Local folder example:

```java
rule "New Local file"
when
Channel "folderwatcher:localfolder:myLocalFolder:newfile" triggered
then
logInfo("NewLocalFile", receivedEvent.toString())
end
```

FTP example:

```java
rule "New FTP file"
when
Channel "folderwatcher:ftpfolder:myFTPFolder:newfile" triggered
when
Channel 'folderwatcher:ftpfolder:XXXXX:newfile' triggered
then
logInfo("NewFTPFile", receivedEvent.toString())

logInfo('NewFTPFile', receivedEvent.toString())

end
```

S3 bucket example:
Local folder example:

```java
rule "New S3 file"
when
Channel "folderwatcher:s3bucket:myS3bucket:newfile" triggered
rule "New Local file"
when
Channel 'folderwatcher:localfolder:XXXXX:newfile' triggered
then
logInfo("NewS3File", receivedEvent.toString())

logInfo('NewLocalFile', receivedEvent.toString())

end
```
10 changes: 5 additions & 5 deletions bundles/org.openhab.binding.foobot/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ The discovery process is able to automatically discover all devices associated w

Bridge has the following configuration parameters:

| Parameter | Description | Required
|------------------|--------------------------------------------------------|----------
| apikey | API Key from <https://api.foobot.io/apidoc/index.html> | Mandatory
| username | The e-mail address used to log into the Foobot App | Mandatory
| refreshInterval | Refresh interval in minutes, minimal 5 minutes | Optional, the default value is 8 minutes.
| Parameter | Description | Required
|------------------|-------------------------------------------------------|----------
| apikey | API Key from <https://api.foobot.io/apidoc/index.html> | Mandatory
| username | The e-mail address used to log into the Foobot App | Mandatory
| refreshInterval | Refresh interval in minutes, minimal 5 minutes | Optional, the default value is 8 minutes.

The minimal refresh rate is 5 minutes because the device only sends data every 5 minutes.
The default is 8 minutes. This will get you through the day with the default rate limit of 200 calls per day.
Expand Down
20 changes: 9 additions & 11 deletions bundles/org.openhab.binding.fsinternetradio/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ Successfully tested are internet radios:
- [Roberts Stream 83i and 93i](https://www.robertsradio.com/uk/products/radio/smart-radio/)
- [Auna Connect 150, Auna KR200, Auna Connect CD](https://www.auna.de/Radios/Internetradios/)
- [TechniSat DIGITRADIO 350 IR and 850](https://www.technisat.com/en_XX/DAB+-Radios-with-Internetradio/352-10996/)
- [TechniSat VIOLA 2 C IR](https://www.technisat.com/de_DE/VIOLA-2-C-IR/352-10996-22713/?article=0010/3933)
- [TTMicro AS Pinell Supersound](https://www.ttmicro.no/radio)
- [Revo SuperConnect](https://revo.co.uk/products/)
- [Sangean WFR-28C](https://sg.sangean.com.tw/products/product_category.asp?cid=2)
Expand Down Expand Up @@ -78,7 +77,6 @@ This list is just an example how the mapping looks like for some of the devices,
| Medion MD87180 | Internet Radio | Music Player (USB, LAN) | DAB Radio | FM Radio | AUX in | - | - | - | - | - |- | - | - | - |
| Medion MD 86988 | Internet Radio | Music Player | FM Radio | AUX in | - | - | - | - | - | - |- | - | - | - |
| Technisat DigitRadio 580 | Internet Radio | Spotify | - | Music Player | DAB Radio | FM Radio | AUX in | CD | Bluetooth | - |- | - | - | - |
| Technisat VIOLA 2 C IR | Internet Radio | Podcasts | DAB Radio | FM Radio | - | - | - | | | - |- | - | - | - |
| Dual IR 3a | Internet Radio | Spotify | - | Music Player | DAB Radio | FM Radio | Bluetooth | - | - | - |- | - | - | - |
| Silvercrest SIRD 14 C1 | - | Napster | Deezer | Qobuz | Spotify | TIDAL | Spotify | Music Player | DAB Radio | FM Radio | AUX in | - | - | - |
| Silvercrest SIRD 14 C2 | Internet Radio | TIDAL | Deezer | Qobuz | Spotify | - | Music Player | DAB Radio | FM Radio | AUX in |- | - | - | - |
Expand Down Expand Up @@ -112,14 +110,14 @@ demo.sitemap:
```perl
sitemap demo label="Main Menu"
{
Frame {
Switch item=RadioPower
Slider visibility=[RadioPower==ON] item=RadioVolume
Switch visibility=[RadioPower==ON] item=RadioMute
Selection visibility=[RadioPower==ON] item=RadioPreset mappings=[0="Favourit 1", 1="Favourit 2", 2="Favourit 3", 3="Favourit 4"]
Selection visibility=[RadioPower==ON] item=RadioMode mappings=[0="Internet Radio", 1="Musik Player", 2="DAB", 3="FM", 4="AUX"]
Text visibility=[RadioPower==ON] item=RadioInfo1
Text visibility=[RadioPower==ON] item=RadioInfo2
}
Frame {
Switch item=RadioPower
Slider visibility=[RadioPower==ON] item=RadioVolume
Switch visibility=[RadioPower==ON] item=RadioMute
Selection visibility=[RadioPower==ON] item=RadioPreset mappings=[0="Favourit 1", 1="Favourit 2", 2="Favourit 3", 3="Favourit 4"]
Selection visibility=[RadioPower==ON] item=RadioMode mappings=[0="Internet Radio", 1="Musik Player", 2="DAB", 3="FM", 4="AUX"]
Text visibility=[RadioPower==ON] item=RadioInfo1
Text visibility=[RadioPower==ON] item=RadioInfo2
}
}
```
8 changes: 4 additions & 4 deletions bundles/org.openhab.binding.gardena/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,10 @@ Sensor refresh commands are not yet supported by the Gardena smart system integr
```java
// smart Water Control
String WC_Valve_Activity "Valve Activity" { channel="gardena:water_control:home:myWateringComputer:valve#activity" }
Number:Time WC_Valve_Duration "Last Watering Duration [%d min]" { channel="gardena:water_control:home:myWateringComputer:valve#duration" }
Number WC_Valve_Duration "Last Watering Duration [%d min]" { channel="gardena:water_control:home:myWateringComputer:valve#duration" }

Number:Time WC_Valve_cmd_Duration "Command Duration [%d min]" { channel="gardena:water_control:home:myWateringComputer:valve_commands#commandDuration" }
Switch WC_Valve_cmd_OpenWithDuration "Start Watering Timer" { channel="gardena:water_control:home:myWateringComputer:valve_commands#start_seconds_to_override" }
Number WC_Valve_cmd_Duration "Command Duration [%d min]" { channel="gardena:water_control:home:myWateringComputer:valve_commands#commandDuration" }
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" }

openhab:status WC_Valve_Duration // returns the duration of the last watering request if still active, or 0
Expand All @@ -101,7 +101,7 @@ openhab:status WC_Valve_Activity // returns the current valve activity (CLOSED|
All channels are read-only, except the command group and the lastUpdate timestamp

```shell
openhab:send WC_Valve_cmd_Duration.sendCommand(600) // set the duration for the command to 10min
openhab:send WC_Valve_cmd_Duration.sendCommand(10) // set the duration for the command to 10min
openhab:send WC_Valve_cmd_OpenWithDuration.sendCommand(ON) // start watering
openhab:send WC_Valve_cmd_CloseValve.sendCommand(ON) // stop any active watering
```
Expand Down
Loading

0 comments on commit abc627f

Please sign in to comment.