demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-10 15:11:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

[FolderWatcher] Formatting and write out of abbreviations in Docs (#14793)

Browse Source 
* Formatting and write out of abbreviations of time

- `s` --> `in seconds`
- `h` --> `in hours`
- formatting of tables, things and rules
- Unifiy usage of `'` and `"`

* Formatting and rephrasing
* Unify the order of localfolder, ftpfolder and s3bucket

Signed-off-by: Felix Schneider <fs@felix-schneider.org>
This commit is contained in:
Felix Schneider 2023-05-02 22:17:21 +02:00 committed by GitHub
parent f607dde3a5
commit 3130a67d8d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
bundles/org.openhab.binding.folderwatcher/README.md
View File

@ -1,37 +1,37 @@
# FolderWatcher Binding
This binding is intended to monitor FTP, local folder and S3 bucket and its subfolders and notify of new files
This binding is intended to monitor a local folder, FTP and S3 bucket and their subfolders and notify of new files.
## Supported Things
Currently the binding support three types of things: `ftpfolder`, `localfolder` and `s3bucket`.
The binding support three types of things: `localfolder`, `ftpfolder` and `s3bucket`.
## Thing Configuration
The `ftpfolder` thing has the following configuration options:
| 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 `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 |
| ------------------ | --------------------------- | ----------------------------------- | -------- | ------------- |
| 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 |
The `ftpfolder` thing has the following configuration options:
| 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:
@ -46,7 +46,7 @@ The `s3bucket` thing has the following configuration options:
| s3Anonymous | Anonymous Connection | Connect anonymously (works for public buckets) | yes | true |
## Events
This binding currently supports the following events:
This binding supports the following event:
| Channel Type ID | Item Type | Description |
|-----------------|-----------|----------------------------|
@ -65,19 +65,6 @@ folderwatcher:s3bucket:myS3bucket [ s3BucketName="mypublic-bucket", pollIn
### Using in a rule:
FTP example:
```java
rule "New FTP file"
when
Channel "folderwatcher:ftpfolder:myLocalFolder:newfile" triggered
then
logInfo("NewFTPFile", receivedEvent.toString())
end
```
Local folder example:
```java
@ -85,9 +72,18 @@ rule "New Local file"
when
Channel "folderwatcher:localfolder:myFTPFolder:newfile" triggered
then
logInfo("NewLocalFile", receivedEvent.toString())
end
```
FTP example:
```java
rule "New FTP file"
when
Channel "folderwatcher:ftpfolder:myLocalFolder:newfile" triggered
then
logInfo("NewFTPFile", receivedEvent.toString())
end
```
@ -98,8 +94,6 @@ rule "New S3 file"
when
Channel "folderwatcher:s3bucket:myS3bucket:newfile" triggered
then
logInfo("NewS3File", receivedEvent.toString())
end
```