From ae621ca5285f4269d2616de30e42ddabcd3ecbd6 Mon Sep 17 00:00:00 2001 From: "bernhard.trinnes" Date: Fri, 13 Mar 2020 14:03:14 +0100 Subject: [PATCH] reworked boblight, bose and coinmarketcap --- boblight/README.md | 40 ++++++++++++++++++++++++++++++++++------ bose/README.md | 32 +++++++++++++++++++++++++++----- coinmarketcap/README.md | 21 ++++++++++++++++++--- 3 files changed, 79 insertions(+), 14 deletions(-) diff --git a/boblight/README.md b/boblight/README.md index a0690f79..f7708592 100644 --- a/boblight/README.md +++ b/boblight/README.md @@ -1,9 +1,37 @@ -# Boblight +--- +id: boblight +title: Boblight +--- -This plugin allows to communicate with a [boblight server](https://code.google.com/p/boblight/) -running on `localhost:19333`. If a boblight server is running, the configured light devices from the server will -appear automatically in nymea. +This plugin allows to communicate with a [Boblight server](https://code.google.com/p/boblight/) + +The boblight server needs to be installed and running. In nymea it is required to setup the Boblight server connection first, during the setup you can configure how many channels you want to add. Each channel will appear auotamtically as an own device insided nymea. Default configuration for the Boblight server is `localhost:19333`, you can change the parameters during device setup. + +Once the Boblight devices are added you can control them like any other color light in nymea. + + +## Supported Things + +* Boblight Server + * Gateway device + * Define channel count +* Boblight Channel + * Color light + * Set color + * Set color temperature + * Set brightness + * Set power + +**Generall** + +* No internet connection required + +## Requirements + +* Boblight server running on `localhost:19333` or any other reachable IP address. +* Boblight device connected to the Boblight server. +* The package "nymea-plugin-boblight" must be installed. + +## More For more information regarding the project please visit the [project site](https://sites.google.com/site/wikikrautbox/krautbox/hardware/boblight). - - diff --git a/bose/README.md b/bose/README.md index 4cf0e523..3860ac21 100644 --- a/bose/README.md +++ b/bose/README.md @@ -1,8 +1,30 @@ -# Bose Soundtouch +--- +id: bose +title: Bose SoundTouch +--- -This plug-in controls Bose SoundTouch speakers throught the local API. +This integration plug-in controls Bose SoundTouch speakers throught the local API. -## Device Setup +## Supported Things -To connect the speaker to a WiFi network the Bose SoundTouch app is needed. This plug-in -supports device discovery. Nymea and the speaker are required to be in the same network. +* Bose devices from the SoundTouch series + * Control the player + * Browse presets + * Set volume, bass level + * Store presets + * Auto descovery setup + * No internet or cloud connection required + +## Requirements + +* Any Bose SoundTouch device +* Bose SoundTouch app installed + * to connect the speaker to the WiFi network +* nymea and the SoundTouch device are required to be in the same network. +* ZeroConf multicast messages must not be blocked by the router. +* TCP sockets on port 80 must nor be blocked by the router. + + +## More + +https://www.bose.com/en_us/apps/soundtouch.html diff --git a/coinmarketcap/README.md b/coinmarketcap/README.md index 13ddcd0e..2e9e07a0 100644 --- a/coinmarketcap/README.md +++ b/coinmarketcap/README.md @@ -1,7 +1,11 @@ -#CoinMarketCap +--- +id: coinMarketCap +title: CoinMarketCap +--- -The coin market cap plugin gets the latest crypto prices from coin market cap and displays it in your favorite flat currency. +The coin market cap plugin gets the latest crypto prices from coin market cap and displays it in your favorite fiat currency. +## Supported Things Supported cypto currencies: @@ -16,7 +20,7 @@ Supported cypto currencies: * miota - IOTA * ans - NEO -Supported flat currencies: +Supported fiat currencies: * EUR * USD @@ -33,3 +37,14 @@ Supported flat currencies: * KRW * MXN * RUB + +## Requirements + +* Internet connection +* coinmarketcap.com beeing reachable. +* The package “nymea-plugin-coinmarketcap” must be installed. + +## More + +https://coinmarketcap.com/ +