jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'next' into rc

Browse Source
This commit is contained in:
Franck Nijhof 2022-09-28 20:53:59 +02:00
commit 4f822b2160
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
9 changed files with 108 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/test.yml vendored
View File

@ -10,7 +10,7 @@ jobs:
- name: Check out files from GitHub
uses: actions/checkout@v3.0.2
- name: Setting up Node.js
uses: actions/setup-node@v3.4.1
uses: actions/setup-node@v3.5.0
with:
node-version: 16.x
cache: "npm"
@ -27,7 +27,7 @@ jobs:
- name: Check out files from GitHub
uses: actions/checkout@v3.0.2
- name: Setting up Node.js
uses: actions/setup-node@v3.4.1
uses: actions/setup-node@v3.5.0
with:
node-version: 16.x
cache: "npm"

2
Gemfile
View File

@ -19,7 +19,7 @@ group :jekyll_plugins do
gem 'jekyll-toc', '0.17.1'
end
gem 'sinatra', '3.0.0'
gem 'sinatra', '3.0.1'
gem 'nokogiri', '1.13.8'
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem

8
Gemfile.lock
View File

@ -80,7 +80,7 @@ GEM
public_suffix (5.0.0)
racc (1.6.0)
rack (2.2.4)
rack-protection (3.0.0)
rack-protection (3.0.1)
rack
rake (13.0.6)
rb-fsevent (0.11.2)
@ -97,10 +97,10 @@ GEM
ffi (~> 1.9)
sassc (2.1.0-x64-mingw32)
ffi (~> 1.9)
sinatra (3.0.0)
sinatra (3.0.1)
mustermann (~> 3.0)
rack (~> 2.2, >= 2.2.4)
rack-protection (= 3.0.0)
rack-protection (= 3.0.1)
tilt (~> 2.0)
stringex (2.8.5)
terminal-table (2.0.0)
@ -127,7 +127,7 @@ DEPENDENCIES
rake (= 13.0.6)
sass-globbing (= 1.1.5)
sassc (= 2.1.0)
sinatra (= 3.0.0)
sinatra (= 3.0.1)
stringex (= 2.8.5)
tzinfo (~> 2.0)
tzinfo-data

203
source/_integrations/apcupsd.markdown
View File

@ -1,7 +1,6 @@
---
title: apcupsd
description: Instructions on how to integrate apcupsd status with Home Assistant.
logo: apcupsd.png
ha_category:
- Binary Sensor
- Sensor
@ -9,18 +8,21 @@ ha_category:
ha_release: 0.13
ha_iot_class: Local Polling
ha_domain: apcupsd
ha_config_flow: true
ha_codeowners:
- '@yuxincs'
ha_platforms:
- binary_sensor
- sensor
ha_integration_type: integration
---
[Apcupsd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) on the APC device.
[apcupsd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) on the APC device.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Sensor](#sensor)
- [Sensor](#sensors)
## Home Assistant add-on installation
@ -28,136 +30,95 @@ Install this [unofficial add-on](https://github.com/korylprince/hassio-apcupsd/)
After installation, follow the instructions on the GitHub page to configure the plugin. Then continue to follow the integration configurations below.
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
apcupsd:
```
{% configuration %}
host:
description: The hostname/IP address on which the apcupsd NIS is being served.
required: false
type: string
default: localhost
port:
description: The port on which the apcupsd NIS is listening.
required: false
type: integer
default: 3551
{% endconfiguration %}
{% include integrations/config_flow.md %}
<div class='note'>
If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [Apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addresses will not connect.
If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addresses will not connect.
</div>
</div>
## Binary sensor
In addition to the [Apcupsd Sensor](#sensor) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times.
This integration provides a binary sensor for the following information from apcupsd:
### Configuration
- UPS status
To enable this sensor, you first have to set up apcupsd integration (above), and add the following lines to your `configuration.yaml` file:
## Sensors
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: apcupsd
```
This integration provides sensors for the following information from apcupsd based on their availability. Each sensor is listed here along with their corresponding resource name obtained from `apcaccess`.
{% configuration %}
name:
description: Name to use in the frontend.
required: false
type: string
default: UPS Online Status
{% endconfiguration %}
<div class='note'>
## Sensor
Some sensors are disabled by default, since they provide information that is only useful for advanced users. You can manually enable them in **{% my entities title="Settings -> Devices & Services -> Entities" %}** -> the sensor entity you want to enable -> Advanced settings -> Enabled.
The `apcupsd` sensor platform allows you to monitor a UPS (battery backup) by using data from the [apcaccess](https://linux.die.net/man/8/apcaccess) command.
</div>
### Configuration
- UPS Alarm Delay (ALARMDEL)
- UPS Ambient Temperature (AMBTEMP)
- UPS Status Data (APC)
- UPS Model (APCMODEL)
- UPS Bad Batteries (BADBATTS)
- UPS Battery Replaced (BATTDATE)
- UPS Battery Status (BATTSTAT)
- UPS Battery Voltage (BATTV)
- UPS Battery (BCHARGE)
- UPS Cable Type (CABLE)
- UPS Total Time on Battery (CUMONBATT)
- UPS Status Date (DATE)
- UPS Dip Switch Settings (DIPSW)
- UPS Low Battery Signal (DLOWBATT)
- UPS Driver (DRIVER)
- UPS Shutdown Delay (DSHUTD)
- UPS Wake Delay (DWAKE)
- UPS Date and Time (END APC)
- UPS External Batteries (EXTBATTS)
- UPS Firmware Version (FIRMWARE)
- UPS Transfer High (HITRANS)
- UPS Hostname (HOSTNAME)
- UPS Ambient Humidity (HUMIDITY)
- UPS Internal Temperature (ITEMP)
- UPS Last Transfer (LASTXFER)
- UPS Input Voltage Status (LINEFAIL)
- UPS Line Frequency (LINEFREQ)
- UPS Input Voltage (LINEV)
- UPS Load (LOADPCT)
- UPS Load Apparent Power (LOADAPNT)
- UPS Transfer Low (LOTRANS)
- UPS Manufacture Date (MANDATE)
- UPS Master Update (MASTERUPD)
- UPS Input Voltage High (MAXLINEV)
- UPS Battery Timeout (MAXTIME)
- UPS Battery Shutdown (MBATTCHG)
- UPS Input Voltage Low (MINLINEV)
- UPS Shutdown Time (MINTIMEL)
- UPS Model (MODEL)
- UPS Battery Nominal Voltage (NOMBATTV)
- UPS Nominal Input Voltage (NOMINV)
- UPS Nominal Output Voltage (NOMOUTV)
- UPS Nominal Output Power (NOMPOWER)
- UPS Nominal Apparent Power (NOMAPNT)
- UPS Transfer Count (NUMXFERS)
- UPS Output Current (OUTCURNT)
- UPS Output Voltage (OUTPUTV)
- UPS Register 1 Fault (REG1)
- UPS Register 2 Fault (REG2)
- UPS Register 3 Fault (REG3)
- UPS Restore Requirement (RETPCT)
- UPS Last Self Test (SELFTEST)
- UPS Sensitivity (SENSE)
- UPS Serial Number (SERIALNO)
- UPS Startup Time (STARTTIME)
- UPS Status Flag (STATFLAG)
- UPS Status (STATUS)
- UPS Self Test Interval (STESTI)
- UPS Time Left (TIMELEFT)
- UPS Time on Battery (TONBATT)
- UPS Mode (UPSMODE)
- UPS Name (UPSNAME)
- UPS Daemon Info (VERSION)
- UPS Transfer from Battery (XOFFBAT)
- UPS Transfer from Battery (XOFFBATT)
- UPS Transfer to Battery (XONBATT)
To use this sensor platform, you first have to set up apcupsd integration (above), and add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: apcupsd
resources:
- bcharge
- linev
```
{% configuration %}
resources:
description: Contains all entries to display.
required: true
type: list
{% endconfiguration %}
### Example
Given the following output from `apcaccess`:
```yaml
APC : 001,051,1149
DATE : 2016-02-09 17:13:31 +0000
HOSTNAME : localhost
VERSION : 3.14.12 (29 March 2014) redhat
UPSNAME : netrack
CABLE : Custom Cable Smart
DRIVER : APC Smart UPS (any)
UPSMODE : Stand Alone
STARTTIME: 2016-02-09 16:06:47 +0000
MODEL : SMART-UPS 1400
STATUS : TRIM ONLINE
LINEV : 247.0 Volts
LOADPCT : 13.0 Percent
BCHARGE : 100.0 Percent
TIMELEFT : 104.0 Minutes
MBATTCHG : 5 Percent
MINTIMEL : 3 Minutes
MAXTIME : 0 Seconds
MAXLINEV : 249.6 Volts
MINLINEV : 244.4 Volts
OUTPUTV : 218.4 Volts
[...]
```
Use the values from the left hand column (lower case required).
Full Example Configuration:
```yaml
sensor:
- platform: apcupsd
resources:
- apc
- date
- hostname
- version
- upsname
- cable
- driver
- upsmode
- starttime
- model
- status
- linev
- loadpct
- bcharge
- timeleft
- mbattchg
- mintimel
- maxtime
- maxlinev
- minlinev
- outputv
```

16
source/_integrations/ezviz.markdown
View File

@ -1,6 +1,6 @@
---
title: Ezviz
description: Integrate Ezviz camera within Home Assistant.
title: EZVIZ
description: Integrate EZVIZ camera within Home Assistant.
ha_release: 0.107
ha_category:
- Camera
@ -18,10 +18,10 @@ ha_platforms:
ha_integration_type: integration
---
The `ezviz` sensor platform uses the EzvizLife API to interact with the devices.
The `ezviz` sensor platform uses the ezvizlife.com API to interact with the devices.
It also exposes an RTSP stream, by using the local camera IPs (so the device hosting Home Assistant has to be able to access the local IP of the cameras).
As there is no official documentation for the API, the component retrieves data from the API used in the Ezviz mobile app, [hosted here](https://apiieu.ezvizlife.com).
As there is no official documentation for the API, the component retrieves data from the API used in the EZVIZ mobile app, [hosted here](https://apiieu.ezvizlife.com).
The password for each camera is usually written near the QR code. This could be underneath the device or in the user manual. It is usually referred to as the camera "verification code".
@ -33,7 +33,7 @@ You can also change the camera options should you need to access a high or low r
### Service `ezviz.alarm_sound`
If your Ezviz camera supports warning sounds, you can use this service to set the intensity.
If your EZVIZ camera supports warning sounds, you can use this service to set the intensity.
| Service data attribute | Description |
| -----------------------| ----------- |
@ -42,7 +42,7 @@ If your Ezviz camera supports warning sounds, you can use this service to set th
### Service `ezviz.ptz`
If your Ezviz camera supports PTZ, you will be able to pan or tilt your camera.
If your EZVIZ camera supports PTZ, you will be able to pan or tilt your camera.
| Service data attribute | Description |
| -----------------------| ----------- |
@ -52,7 +52,7 @@ If your Ezviz camera supports PTZ, you will be able to pan or tilt your camera.
### Service `ezviz.set_alarm_detection_sensibility`
If your Ezviz camera supports motion detection, you will be able to set the sensitivity level using this service.
If your EZVIZ camera supports motion detection, you will be able to set the sensitivity level using this service.
| Service data attribute | Description |
| -----------------------| ----------- |
@ -62,7 +62,7 @@ If your Ezviz camera supports motion detection, you will be able to set the sens
### Service `ezviz.sound_alarm`
If your Ezviz camera has a built-in siren, you can use this service to make a noise.
If your EZVIZ camera has a built-in siren, you can use this service to make a noise.
| Service data attribute | Description |
| -----------------------| ----------- |

6
source/_integrations/sensor.markdown
View File

@ -27,6 +27,7 @@ The type of data a sensor returns impacts how it is displayed in the frontend. T
- **carbon_monoxide**: Carbon Monoxide in CO (Gas CNG/LPG)
- **current**: Current in A
- **date**: Date string (ISO 8601)
- **distance**: Generic distance in km, m, cm, mm, mi, yd, or in
- **duration**: Duration in days, hours, minutes or seconds
- **energy**: Energy in Wh, kWh or MWh
- **frequency**: Frequency in Hz, kHz, MHz or GHz
@ -44,14 +45,17 @@ The type of data a sensor returns impacts how it is displayed in the frontend. T
- **pm25**: Concentration of particulate matter less than 2.5 micrometers in µg/m³
- **power_factor**: Power factor in %
- **power**: Power in W or kW
- **pressure**: Pressure in Pa, kPa, hPa, bar, cbar, mbar, mmHg, inHg or psi
- **pressure**: Pressure in Pa, kPa, hPa, bar, cbar, mbar, mmHg, inHg, or psi
- **reactive_power**: Reactive power in var
- **signal_strength**: Signal strength in dB or dBm
- **speed**: Generic speed in ft/s, in/d, in/h, km/h, kn, m/s, mph, or mm/d
- **sulphur_dioxide**: Concentration of sulphur dioxide in µg/m³
- **temperature**: Temperature in °C or °F
- **timestamp**: Datetime object or timestamp string (ISO 8601)
- **volatile_organic_compounds**: Concentration of volatile organic compounds in µg/m³
- **voltage**: Voltage in V
- **volume**: Generic volume in L, mL, gal, fl. oz., m³, or ft³
- **weight**: Generic mass in kg, g, mg, µg, oz, or lb
<p class='img'>
<img src='/images/screenshots/sensor_device_classes_icons.png' />

2
source/_integrations/slack.markdown
View File

@ -24,7 +24,7 @@ The `slack` platform allows you to deliver notifications from Home Assistant to
1. Create a [new app](https://api.slack.com/apps) under your Slack.com account.
2. Click the `OAuth & Permissions` link in the sidebar, under the Features heading.
3. In the Scopes section, add the `chat:write` scope, `Send messages as user`. If you get a `missing_scope` error when trying to send a message, check these permissions.
4. Scroll up to `OAuth Tokens & Redirect URLs` and click `Add to Workspace`.
4. Scroll up to `OAuth Tokens & Redirect URLs` and click `Install to Workspace`.
5. Copy your `OAuth Access Token` and put that key into the config flow.
<div class='note'>

3
source/_integrations/switchbee.markdown
View File

@ -3,6 +3,7 @@ title: SwitchBee
description: Instructions for how to integrate SwitchBee accessories within Home Assistant.
ha_category:
- Switch
- Light
- Button
ha_release: 2022.10
ha_iot_class: local Polling
@ -12,6 +13,7 @@ ha_codeowners:
ha_domain: switchbee
ha_platforms:
- switch
- light
- button
ha_integration_type: integration
@ -25,6 +27,7 @@ There is currently support for the following device types:
- Timed Power Switch (Boiler)
- Group Switch
- Timed Switch
- Light (Dimmer)
- Scenario
Supported devices will be discovered after the SwitchBee integration is configured.

3
source/_integrations/switcher_kis.markdown
View File

@ -66,4 +66,5 @@ Note: This does not affect the auto off timer.
## Notes
If Home Assistant and your Switcher are not on the same network, you need to create a firewall rule, which allows a connection on port 20002 with the UDP protocol from Switcher to your Home Assistant and port 9957 with the TCP protocol from Home Assistant to your Switcher.
Make sure that Home Assistant host's firewall allows incoming traffic on UDP port 20002 and outgoing connections to Switcher device(s) on TCP port 9957.
If Home Assistant and the Switcher device(s) are not on the same network, you will also need to have their traffic properly forwarded between the two networks.