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

24
bundles/org.openhab.binding.ftpupload/README.md
View File

@@ -33,7 +33,6 @@ The `ftpupload` Thing has the following configuration parameters:
| userName | User name to login to the FTP server. User name is used to identify the Thing, so it should be unique per Thing. | yes | |
| password | Password to login to the FTP server. | yes | |
## Channels
This binding currently supports the following channels:
@@ -54,7 +53,6 @@ Image channel supports following options:
|-------------|--------------|--------------------------------------------------------------------------|----------|---------------|
| filename | Filename | Filename to match received files. Supports regular expression patterns. | yes | .* |
### Trigger Channels
| Channel Type ID | Options | Description |
@@ -64,7 +62,7 @@ Image channel supports following options:
When an image file is uploaded to FTP server, the binding tries to find the trigger channel whose filename matches the upload image filename.
If no match is found, no channel is updated.
The filename parameter supports regular expression patterns.
See more details in the Things example.
See more details in the Things example.
Trigger channels supports following options:
@@ -76,7 +74,7 @@ Trigger channels supports following options:
Things:
```
```java
Thing ftpupload:imagereceiver:images1 [ userName="test1", password="12345" ] {
Thing ftpupload:imagereceiver:images2 [ userName="test2", password="12345" ] {
@@ -98,14 +96,14 @@ Thing ftpupload:imagereceiver:images2 [ userName="test2", password="12345" ] {
Items:
```
```java
Image Image1 { channel="ftpupload:imagereceiver:images1:image" }
Image Image2 { channel="ftpupload:imagereceiver:images2:my_image1" }
```
Rules:
```
```java
rule "example trigger rule 1"
when
Channel 'ftpupload:imagereceiver:images1:image-received' triggered IMAGE_RECEIVED
@@ -124,7 +122,7 @@ end
Sitemap:
```
```perl
Frame label="FTP images" {
Image item=Image1
Image item=Image2
@@ -137,19 +135,19 @@ The binding can be used to receive images from network cameras that send images
Things:
```
```java
Thing ftpupload:imagereceiver:garagecamera [ userName="garage", password="12345" ]
```
Items:
```
```java
Image Garage_NetworkCamera_Motion_Image { channel="ftpupload:imagereceiver:garagecamera:image" }
```
Rules:
```
```java
rule "example trigger rule"
when
Channel 'ftpupload:imagereceiver:garagecamera:image-received' triggered IMAGE_RECEIVED
@@ -160,7 +158,7 @@ end
Sitemap:
```
```perl
Frame label="Garage network camera" icon="camera" {
Image item=Garage_NetworkCamera_Motion_Image
}
@@ -170,13 +168,13 @@ Frame label="Garage network camera" icon="camera" {
For problem solving, if binding logging is not enough, Apache FTP server logging can also be enabled by the following command in the Karaf console:
```
```shell
log:set DEBUG org.apache.ftpserver
```
and set back to default level:
```
```shell
log:set DEFAULT org.apache.ftpserver
```