felix/homeassistant_custom_components
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated docu

Browse Source
This commit is contained in:
Felix Steghofer
2018-02-10 01:47:22 +01:00
parent 4b70d5b325
commit 0ebfa6b58b
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -6,7 +6,7 @@
[Shinobi](https://shinobi.video/) is an open source cctv solution.
To enable this component, first copy `custom_components/` inside your Home Assistant config directory and add the Shinobi component and platform, for example in `configuration.yaml`. See https://github.com/moeiscool/Shinobi/wiki/API-Access on how to get your `api_key` and `group_key`. The `ssl` param is optional and defaults to `false`. The white- and blacklist is also optional and defaults to all active monitors. It can also be only one filtering method applied. For now, the name assigned in Shinobi is used to filter cams.
To enable this component, first copy `custom_components/` inside your Home Assistant config directory and add the Shinobi component and platform, for example in `configuration.yaml`. See https://github.com/moeiscool/Shinobi/wiki/API-Access on how to get your `api_key` and `group_key`. The `ssl` param is optional and defaults to `false`. The white- and blacklist is also optional and defaults to all active monitors being considered. Only one filtering method can be applied at the same time. For now, the name assigned in Shinobi is used to filter cams.
```
…
@@ -26,12 +26,13 @@ camera:
…
```
At the moment, all configured and activated cameras (in state, `Record` or `Watch-only`, see https://shinobi.video/docs/settings) are fetched and added to Home Assistant as `MjpegCamera`.
No additional packages have to be installed.
At the moment, all configured and activated cameras (in state, `Record` or `Watch-only`, see https://shinobi.video/docs/settings) are fetched and added to Home Assistant as `MjpegCamera`. For this to work, the stream type has to be set to mjpeg in shinobi (in the individual camera settings, for all cameras that should be displayed in HA, still preview is working fine anyway if the jpeg API is enabled [default in shinobi])
No additional packages have to be installed.
## TODO
- figure out which camera platform is working best for this (Shinobi allows to switch between different stream output configs)
- figure out which camera platform is working best for this (Shinobi allows to switch between different stream output configs, atm only mjpeg is supported as described above)
- add movement detection as (binary?) sensors
- add ptz control (as switches? I have not yet seen a good solution in HA, anybody who can help please drop some lines)
- …