continued to improve readmes
Bernhard Trinnes
parent
3fb5d7d47e
commit
2cb02d5a60
|
|
@ -3,7 +3,7 @@
|
|||
"tagline": "Connect to Boblight devices.",
|
||||
"icon": "boblight.png",
|
||||
"stability": "community",
|
||||
"offline": false,
|
||||
"offline": true,
|
||||
"technologies": [
|
||||
"network"
|
||||
],
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# Application and script launcher
|
||||
# Application and Bashscript Launcher
|
||||
|
||||
This plugin allows you to execute system commands and start bash scripts.
|
||||
|
||||
## Supported Things
|
||||
## Usage
|
||||
|
||||
### Application launcher
|
||||
|
||||
|
|
@ -59,6 +59,17 @@ To make the script executable use following command:
|
|||
|
||||
chmod +x backup.sh
|
||||
|
||||
## Supported Things
|
||||
|
||||
* Application launcher
|
||||
* Enter command during thing setup
|
||||
* Get running state
|
||||
* Trigger and kill the command
|
||||
* Bashscript launcher
|
||||
* Enter script during thing setup
|
||||
* Get running state
|
||||
* Trigger and kill the script
|
||||
|
||||
## Requirements
|
||||
|
||||
* The package “nymea-plugin-commandlauncher” must be installed.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
"title": "Command Launcher",
|
||||
"tagline": "Launch local commands or bash scripts.",
|
||||
"icon": "commandlauncher.svg",
|
||||
"stability": "community",
|
||||
"stability": "consumer",
|
||||
"offline": true,
|
||||
"technologies": [
|
||||
],
|
||||
|
|
|
|||
|
|
@ -2,10 +2,18 @@
|
|||
|
||||
The time plugin allows you to create rules based on time, day, month, year, weekday or on weekend.
|
||||
|
||||
## Usage
|
||||
|
||||
For the correct setup, you can configure the time zone in the plugin configuration. The language
|
||||
of the "month name" and "weekday name" depends on the locale settings of your system. To have the correct
|
||||
time you need [ntp](https://en.wikipedia.org/wiki/Network_Time_Protocol).
|
||||
|
||||
** Today **
|
||||
|
||||
The today thing gives you information about the current day and some special times of the day like
|
||||
dawn, sunrise, noon, sunset and dawn. In order to get the correct times of the current day for your location, the plugin needs to know where you are. The plugin will autodetect your location according to you WAN IP [http://ip-api.com/json](http://ip-api.com/json) and will download the sunset / sunrise times from the online database [http://sunrise-sunset.org/](http://sunrise-sunset.org/).
|
||||
If the configured timezone does not match with the autodetected timezone from the IP, the `specialdates` will be set to 0 (01.01.1970 - 00:00.00).
|
||||
|
||||
The weekday integer value stands for:
|
||||
|
||||
* Monday: `1`
|
||||
|
|
@ -18,21 +26,31 @@ The weekday integer value stands for:
|
|||
|
||||
The *weekend* state will be true, if the current weekday is Saturday or Sunday, otherwise it will be false.
|
||||
|
||||
## Today
|
||||
## Supported Things
|
||||
|
||||
The today plugin gives you information about the current day and some special times of the day like
|
||||
dawn, sunrise, noon, sunset and dawn. In order to get the correct times of the current day for your location, the plugin needs to know where you are. The plugin will autodetect your location according to you WAN IP [http://ip-api.com/json](http://ip-api.com/json) and will download the sunset / sunrise times from the online database [http://sunrise-sunset.org/](http://sunrise-sunset.org/).
|
||||
If the configured timezone does not match with the autodetected timezone from the IP, the `specialdates` will be set to 0 (01.01.1970 - 00:00.00).
|
||||
* Today
|
||||
* Get location, country, closest city
|
||||
* Timezone
|
||||
* Get date: weekend, day, month and year
|
||||
* Get astronomic data: dawn, noon, sunset, dusk
|
||||
* Alarm
|
||||
* Define time for trigger
|
||||
* Choose trigger to be time or astronomical events.
|
||||
* Set weekdays
|
||||
* Emits an event on alarm
|
||||
* Countdown
|
||||
* Specify duration hours/minutes/seconds
|
||||
* Start, stop, restart timer
|
||||
* Get running state
|
||||
* Emits event on timeout
|
||||
|
||||
## Requirements
|
||||
|
||||
* Internet connection
|
||||
* The package 'nymea-plugin-datetime' must be installed.
|
||||
|
||||
## More
|
||||
|
||||
|
||||
|
||||
Special times of a day ([original source](https://en.wikipedia.org/wiki/Twilight#/media/File:Twilight_description_full_day.svg))
|
||||
|
||||
## Alarm
|
||||
|
||||
The alarm plugin allows you to define an alarm which depends on a certain time, weekday or special day time, like sunrise or
|
||||
sunset. An offset can also be defined.
|
||||
|
||||
## Countdown
|
||||
|
||||
The countdown plugin allows you to define a countdown, which triggers an event on timeout.
|
||||
|
|
|
|||
|
|
@ -3,8 +3,9 @@
|
|||
"tagline": "Get astronomical data, set alarm and countdown",
|
||||
"icon": "datetime.svg",
|
||||
"stability": "consumer",
|
||||
"offline": true,
|
||||
"offline": false,
|
||||
"technologies": [
|
||||
"cloud"
|
||||
],
|
||||
"categories": [
|
||||
"sensor"
|
||||
|
|
|
|||
|
|
@ -3,10 +3,11 @@
|
|||
"tagline": "Control GPIOs for Raspberry Pi or BeagleBone Black.",
|
||||
"icon": "gpio.svg",
|
||||
"stability": "community",
|
||||
"offline": false,
|
||||
"offline": true,
|
||||
"technologies": [
|
||||
],
|
||||
"categories": [
|
||||
"sensor"
|
||||
"sensor",
|
||||
"tool"
|
||||
]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,22 @@
|
|||
# HTTP commander
|
||||
# HTTP Commander
|
||||
|
||||
The HTTP commander allows you to send and reqceive generiv HTTP requests.
|
||||
The HTTP commander allows to send and receive raw HTTP requests.
|
||||
|
||||
## HTTP Request
|
||||
## Supported Things
|
||||
|
||||
Send simple HTTP GET/POST/PUT/DELETE requests. URL and port will be defined during setup, body and HTTP method can be set within every request.
|
||||
* HTTP Request
|
||||
* GET/POST/PUT/DELETE
|
||||
* URL and port get defined during thing setup
|
||||
* Body and HTTP method can be set within every request
|
||||
* HTTP Server
|
||||
* GET/POST/PUT/DELETE
|
||||
* Get event with HTTP request type, url and body as parameter.
|
||||
|
||||
## HTTP Server
|
||||
## Requirements
|
||||
|
||||
* The package 'nymea-plugin-httpcommander' must be installed.
|
||||
|
||||
## More
|
||||
|
||||
https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol
|
||||
|
||||
Simple HTTP Server to receive GET/POST/PUT/DELETE requests. Emits an event including HTTP request type, Url and body as parameter.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
"title": "Kodi",
|
||||
"tagline": "Control the Kodi media player.",
|
||||
"icon": "kodi.svg",
|
||||
"stability": "community",
|
||||
"stability": "consumer",
|
||||
"offline": true,
|
||||
"technologies": [
|
||||
"network"
|
||||
|
|
|
|||
|
|
@ -1,5 +1,22 @@
|
|||
# LG Smart TV
|
||||
|
||||
This plugin allows to interact with [LG Smart Tv's](http://www.lg.com/us/experience-tvs/smart-tv)
|
||||
with the [LG UDAP 2.0 Protocol Specifications](http://developer.lgappstv.com/TV_HELP/index.jsp?topic=%2Flge.tvsdk.references.book%2Fhtml%2FUDAP%2FUDAP%2FLG+UDAP+2+0+Protocol+Specifications.htm).
|
||||
This plugin allows to connect to LG Smart TV's.
|
||||
|
||||
## Supported Things
|
||||
|
||||
* LG Smart TV
|
||||
* PIN authentication
|
||||
* Get channel, source, program
|
||||
* Set volume, mute
|
||||
* Power on/off
|
||||
* Menu navigation
|
||||
|
||||
## Requirements
|
||||
|
||||
* The device must be in the same local area network as nymea.
|
||||
* The package 'nymea-plugin-lgsmarttv' must be installed.
|
||||
|
||||
## More
|
||||
|
||||
[LG Smart Tv's](http://www.lg.com/us/experience-tvs/smart-tv)
|
||||
[LG UDAP 2.0 Protocol Specifications](http://developer.lgappstv.com/TV_HELP/index.jsp?topic=%2Flge.tvsdk.references.book%2Fhtml%2FUDAP%2FUDAP%2FLG+UDAP+2+0+Protocol+Specifications.htm).
|
||||
|
|
|
|||
|
|
@ -8,6 +8,6 @@
|
|||
"network"
|
||||
],
|
||||
"categories": [
|
||||
"sensor"
|
||||
"multimedia"
|
||||
]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,3 +3,22 @@
|
|||
The mail notification plugin allows you to send a mail notification from a mail account by performing an action.
|
||||
|
||||
> Note: Google mail is currently not supported since that requires OAuth2.0 which is currently a missing feature.
|
||||
|
||||
## Supported Things
|
||||
|
||||
* E-mail notifications
|
||||
* Username and password login
|
||||
* Send mail
|
||||
|
||||
NOTE: This plug-in is not able to receive E-Mails
|
||||
|
||||
## Requirements
|
||||
|
||||
* The mail sever must be reachable.
|
||||
* Valid user account credentials.
|
||||
* The package 'nymea-plugin-mailnotification' must be installed.
|
||||
|
||||
## More
|
||||
|
||||
https://www.liquidweb.com/kb/how-to-set-up-any-e-mail-client/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,11 +1,10 @@
|
|||
# MQTT client
|
||||
# MQTT Client
|
||||
|
||||
This plugin allows to subscribe and publish to MQTT brokers (the nymea internal broker and external ones).
|
||||
|
||||
> This plugin is ment to be combined with a rule.
|
||||
|
||||
|
||||
## Example
|
||||
## Usage
|
||||
|
||||
A device is configured to publish its state to a MQTT broker. Using this plugin the user can subscribe to
|
||||
the same topic on that broker and monitor the device's state.
|
||||
|
|
@ -14,3 +13,23 @@ Publishing is also supported. This allows use cases such as controlling IoT thin
|
|||
to topics such devices are subscribed to. Other possibilities are to use nymea as a "translator" between other
|
||||
transport layers to MQTT. For instance a sensor might deliver sensor data via Bluetooth to Nymea and using this
|
||||
MQTT plugin and a rule nymea can be configured to forward all those sensor values to a MQTT broker.
|
||||
|
||||
## Supported Things
|
||||
|
||||
* Internal MQTT client
|
||||
* Define topic
|
||||
* Publish messages
|
||||
* MQTT client
|
||||
* Username and password authentication
|
||||
* Topic filter
|
||||
* Received messages
|
||||
* Publish messages
|
||||
|
||||
## Requirements
|
||||
|
||||
* The package 'nymea-plugin-mqttclient' must be installed.
|
||||
|
||||
## More
|
||||
|
||||
https://wikipedia.org/wiki/MQTT
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
"title": "MQTT client",
|
||||
"tagline": "Send and receive raw MQTT messages",
|
||||
"icon": "mqtt.svg",
|
||||
"stability": "community",
|
||||
"stability": "consumer",
|
||||
"offline": true,
|
||||
"technologies": [
|
||||
"network",
|
||||
"mqtt"
|
||||
"mqtt"
|
||||
],
|
||||
"categories": [
|
||||
"tool"
|
||||
|
|
|
|||
|
|
@ -2,4 +2,19 @@
|
|||
|
||||
This plugin allows to find and monitor network devices in your local network by using the hostname of the devices.
|
||||
|
||||
> Note: the application `nmap` has to be installed and nymea has to run as `root`.
|
||||
## Supported Things
|
||||
|
||||
* Network Device
|
||||
* Presence sensor appearance
|
||||
* Grace period adjustable
|
||||
* Present and last seen state
|
||||
|
||||
## Requirements
|
||||
|
||||
* The application `nmap` has to be installed and nymea has to run as `root`.
|
||||
* The network devices needs to be in the same local area network as nymea.
|
||||
* The package 'nymea-plugin-networkdetector'
|
||||
|
||||
## More
|
||||
|
||||
https://nmap.org/
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
"title": "Network Detector",
|
||||
"tagline": "Detect devices connected to the LAN.",
|
||||
"icon": "networkdetector.svg",
|
||||
"stability": "community",
|
||||
"stability": "consumer",
|
||||
"offline": true,
|
||||
"technologies": [
|
||||
"network"
|
||||
|
|
|
|||
|
|
@ -1,3 +1,21 @@
|
|||
# nymea-plugin-nuki
|
||||
# Nuki
|
||||
|
||||
Device plugin for the [Nuki Smartlock](https://nuki.io/en/) Bluetooth API.
|
||||
Integration plugin for the Nuki Smartlock. This plug-in uses Bluetooth to connect to the lock, the Nuki Gateway is not required.
|
||||
|
||||
## Supported Things
|
||||
|
||||
* Smartlock
|
||||
* Push button authentication
|
||||
* Battery status
|
||||
* Lock status (unlocked, locked ...)
|
||||
* Connection mode
|
||||
* Open, lock, unlock door
|
||||
|
||||
## Requirements
|
||||
|
||||
* Bluetooth 4.0 interface on the nymea host device.
|
||||
* The package 'nymea-plugin-nuki' must be installed.
|
||||
|
||||
## More
|
||||
|
||||
https://nuki.io/en/
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
# OpenWeatherMap
|
||||
|
||||
This plugin allows to get the current weather data from [OpenWeatherMap](http://www.openweathermap.org).
|
||||
This plugin allows to get the current weather data from OpenWeatherMap.
|
||||
|
||||
## Usage
|
||||
|
||||
The weather data will be refreshed every 15 minutes automatically, but can also refreshed manually.
|
||||
The plugin offers two different search methods for the location: if the user searches for a empty string,
|
||||
the plugin makes an autodetection with the WAN ip and offers the user the found weather stations.
|
||||
|
|
@ -9,3 +12,25 @@ stations in a radius of 1.5 km. Otherwise the plugin returns the list of the fou
|
|||
from the search string.
|
||||
|
||||
> Note: If you are using a VPN connection, the autodetection will show the results around your VPN location.
|
||||
|
||||
## Supported Things
|
||||
|
||||
* Weather
|
||||
* Weather condition
|
||||
* Temperature
|
||||
* Humidity
|
||||
* Pressure
|
||||
* Wind speed and direction
|
||||
* Cloudiness and visibility
|
||||
* Sunset and sunset time
|
||||
|
||||
## Requirements
|
||||
|
||||
* Internet connection
|
||||
* The OpenWeatherMap must be reachable
|
||||
* The package 'nymea-plugin-openweathermap' must be installed
|
||||
* An API key must be purchased for commercial use.
|
||||
|
||||
## More
|
||||
|
||||
OpenWeatherMap http://www.openweathermap.org
|
||||
|
|
|
|||
|
|
@ -8,8 +8,8 @@ This plugin allows to interact with the Hue bridge. Each light bulb, sensor and
|
|||
* Auto network discovery
|
||||
* Connected devices appear automatically
|
||||
* No internet or cloud connection required
|
||||
* Hue Remote
|
||||
* Hue Tap
|
||||
* Hue Dimmer switch
|
||||
* Hue Tap Switch
|
||||
* Hue Smart Button
|
||||
* Hue Motion Sensor
|
||||
* Hue Outdoor Motion Sensor
|
||||
|
|
|
|||
|
|
@ -8,7 +8,9 @@
|
|||
"network"
|
||||
],
|
||||
"categories": [
|
||||
"gateway",
|
||||
"light",
|
||||
"sensor"
|
||||
"sensor",
|
||||
"switch"
|
||||
]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -8,6 +8,8 @@
|
|||
"network"
|
||||
],
|
||||
"categories": [
|
||||
"sensor"
|
||||
"sensor",
|
||||
"switch",
|
||||
"socket"
|
||||
]
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue