Skip to content

Add sensor types to Envisalink binary sensor docs #1346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add sensor types to Envisalink binary sensor docs #1346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion source/_components/binary_sensor.envisalink.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,26 @@ ha_iot_class: "Local Push"
---

The `envisalink` platform allows you to get data from your [Envisalink](http://www.eyezon.com/) binary sensors from within Home Assistant.

The requirement is that you have setup your [Envisalink hub](/components/envisalink/).

#### Sensor Types
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is already documented at https://home-assistant.io/components/binary_sensor/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and https://home-assistant.io/getting-started/customizing-devices/#possible-values

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I missed that documentation somehow. What're your thoughts on removing the Envisalink binary sensor docs and directly linking there instead? There doesn't appear to be anything specialized about the Envisalink binary sensor that the general component docs don't cover. The zones area can include the link/documentation to the sensor type similar to how the CLI binary sensor does it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I picked some of your changes and introduced them with #1396.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, we can't remove the Envisalink binary sensor docs because we are linking from the configuration check to the docs.


See the [binary_sensor source](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/binary_sensor/__init__.py#L20-L37) for the most up-to-date list of sensor types

* `none` => generic on/off
* `cold` => on means cold (or too cold)
* `connectivity` => On means connection present, Off = no connection
* `gas` => CO, CO2, etc.
* `heat` => On means hot (or too hot)
* `light` => Lightness threshold
* `moisture` => Specifically a wetness sensor
* `motion` => Motion sensor
* `moving` => On means moving, Off means stopped
* `occupancy` => On means occupied, Off means not occupied
* `opening` => Door, window, etc.
* `power` => Power, over-current, etc
* `safety` => Generic on=unsafe, off=safe
* `smoke` => Smoke detector
* `sound` => On means sound detected, Off means no sound
* `vibration` => On means vibration detected, Off means no vibration
3 changes: 1 addition & 2 deletions source/_components/envisalink.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,5 @@ Configuration variables:
- **keepalive_interval** (*Optional*): This is a periodic heartbeat signal (measured in seconds) sent to your Envisalink board to keep it from restarting. This is required for DSC and Honeywell systems. Defaults to `60` seconds.
- **zonedump_interval** (*Optional*): This is an interval (measured in seconds) where the evl will dump out all zone statuses. This is required for Honeywell systems, which do not properly send zone closure events. DSC boards do not technically need this. Default: `30`
- **panic_type** (*Optional*): Both DSC and Honeywell boards support a "panic" alarm. This is used when the alarm_trigger service is called in home assistant. This determines which type of panic alarm to raise. Default = Police. Valid values are: Police, Fire, Ambulance
- **zones** (*Optional*): Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. *Note: if no zones are specified, Home Assistant will not load any binary_sensor components.*
- **zones** (*Optional*): Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.envisalink/) docs. *Note: if no zones are specified, Home Assistant will not load any binary_sensor components.*
- **partitions** (*Optional*): Again, Envisalink boards do not tell us what is in use and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor components are loaded.