ETM-Schurig
/
nymea-plugins
mirror of https://github.com/nymea/nymea-plugins.git
1
0
Fork 0
Code Issues 1 Packages Projects Releases Wiki Activity

reworked aqi, onewire, openuv, systemmonitor and philips hue readme

pull/255/head
Bernhard Trinnes 2020-04-17 14:33:36 +02:00
parent e013b48ce3
commit 6d52c0712d
5 changed files with 116 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
aqi/README.md
View File

@ -1,4 +1,3 @@
# Air Quality Index
This plug-in gets air quality information from http://aqicn.org.

81
onewire/README.md
View File

@ -1,39 +1,60 @@
# One wire
# One-Wire
This plugin allows to add one wire devices through the one wire file system.
This integration plugin allows to integrate one-wire devices like temperature sensors and switches.
## Supported Things
## One wire interface device
This device initializes OWFS, during the device setup you can set OWFS init arguments.
Default arguments are "--i2c=ALL:ALL" to scan for one-wire devices on all I2C interfaces.
* OWFS Interface
* Gateway device
* Initializes OWFS
* Temperature Sensors
* Family Code 10
* DS18S20
* DS1820
* DS18S20-PAR
* DS1920
* Family Code 22
* DS1822
* DS1822-PAR
* Family Code 28
* DS18B20
* DS18B20-PAR
* DS18B20X
* Family Code 3B
* DS1825
* Switches
* Family Code 05
* Single channel switch
* DS2405
* Family Code 12
* Dual channel switch
* DS2406
* DS2407
* Family Code 3A
* Dual channel switch
* DS2413
* Family Code 29
* Eight channel switch
* DS2408
## Usage
First step is to setup the "One wire interface". During the device setup it is required to enter the OWFS init arguments. Default arguments are "--i2c=ALL:ALL", means OWFS is about to scan for one-wire bus masters on all I2C interfaces.
You can simulate one-wire device with following init argument: "--fake=10,22,28,05"
More about init arguments here: https://www.owfs.org
## Supported one-wire devices
The "One wire interface" thing has the toggle button to "Auto add one wire devices". Is this activated one-wire devices that get connected to the bus will appear in nymea automatically.
NOTE: As long as the "Auto add one wire devices" feature is activated you won't be able to manually discover devices.
## Requirements
* The package “nymea-plugin-onewire” must be installed.
## More
This plug-in uses "OWFS" the one-wire file system: https://owfs.org
* Family Code 10 - Temperature Sensors
..* DS18S20
..* DS1820
..* DS18S20-PAR
..* DS1920
* Family Code 22 - Temperature Sensors
..* DS1822
..* DS1822-PAR
* Family Code 28 - Temperature Sensors
..* DS18B20
..* DS18B20-PAR
..* DS18B20X
* Family Code 3B - Temperature Sensors
..* DS1825
* Family Code 05 - Single channel switch
..* DS2405
* Family Code 12 - Dual channel switch
..* DS2406
..* DS2407
* Family Code 3A - Dual channel switch
..* DS2413
* Family Code 29 - Eight channel switch
..* DS2408

24
openuv/README.md
View File

@ -2,5 +2,27 @@
Get the current UV index for your location.
## Supported Things
* OpenUV
* Auto location discovery
* Based on you IP-Address
* UV index
* UV day max index
* max UV Index for the day (at solar noon)
* Ozone in du (Dobson Units)
* Safe exposure time
* Safe exposure time (mins) till burn for each skin type
NOTE: The save exposure time is not available for all regions. If all save exposure times are zero it due to unavailability of this information
## Requirments
* The package “nymea-plugin-openuv” must be installed
* A valid OpenUV API key
* Internet connection
## More
https://www.openuv.io/
The save exposure time is not available for all regions. If all save exposure times are zero it due to unavailability of this information

27
philipshue/README.md
View File

@ -1,3 +1,28 @@
# Philips Hue
This plugin allows to interact with the [Philips hue](http://www2.meethue.com/) bridge. Each light bulb, sensor and remote controller connected to the bridge will appear automatically in the system, once the bridge is added to nymea.
This plugin allows to interact with the Hue bridge. Each light bulb, sensor and remote controller connected to the bridge will appear automatically in the system, once the bridge is added to nymea.
## Supported Things
* Hue Bridge V1 + V2
* Auto network discovery
* Connected devices appear automatically
* No internet or cloud connection required
* Hue Remote
* Hue Tap
* Hue Smart Button
* Hue Motion Sensor
* Hue Outdoor Motion Sensor
* Hue Ambient White Bulb
* Hue Color Bulb
* Any other Bulb that can be connected and controlled by the Hue App.
## Requirements
* The Philips Hue bridge must be in the same local area network as nymea.
* The package “nymea-plugin-philipshue” must be installed
* Access to the Philips Hue bidge push button
## More
[Philips hue](http://www2.meethue.com/)

22
systemmonitor/README.md
View File

@ -1,9 +1,19 @@
# Systemmonitor
# System monitor
Displays the system usage of nymea, containing:
This integration plug-in displays the system usage of nymea.
* CPU usage (in percent)
* Memory usage (in percent)
* RSS memory usage (in KiloByte)
* Virtual memory usage (in KiloByte)
## Supported Things
* System monitor
* CPU usage (in percent)
* Memory usage (in percent)
* RSS memory usage (in KiloByte)
* Virtual memory usage (in KiloByte)
## Requirements
* The package “nymea-plugin-systemmonitor” must be installed
## More
This plug-in uses "ps" to gather the required system information: http://man7.org/linux/man-pages/man1/ps.1.html