Updated external content (Jenkins build 370)

pull/1569/head
openHAB Build Server 2021-04-10 15:25:37 +00:00
parent df276ee968
commit 8dc023d2d6
6 changed files with 275 additions and 4 deletions

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,71 @@
---
id: homewizard
label: HomeWizard
title: HomeWizard - Bindings
type: binding
description: "The HomeWizard binding retrieves measurements from the HomeWizard Wi-Fi P1 meter."
since: 3x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# HomeWizard Binding
The HomeWizard binding retrieves measurements from the HomeWizard Wi-Fi P1 meter.
The meter itself is attached to a DSMR Smart Meter and reads out the telegrams, which it will forward to cloud storage.
However, recently HomeWizard also added an interface that can be queried locally.
This binding uses that local interface to make the measurements available.
## Supported Things
The binding provides the P1 Meter thing.
## Discovery
Auto discovery is not available for this binding.
## Thing Configuration
The P1 Meter thing can be configured through the web interface.
| Parameter | Required | Default | Description |
|--------------|----------|---------|---------------------------------------------------------------------------------------------------|
| ipAddress | * | | This specifies the IP address (or host name) where the meter can be found. |
| refreshDelay | | 5 | This specifies the interval in seconds used by the binding to read updated values from the meter. |
Note that update rate of the P1 Meter itself depends on the frequency of the telegrams it receives from the Smart Meter.
For DSMR5 meters this is generally once per second, for older versions the frequency is much lower.
Example of configuration through a .thing file:
```
Thing homewizard:p1_wifi_meter:my_meter [ ipAddress="192.178.1.67", refreshDelay=5 ]
```
## Channels
| Channel ID | Item Type | Description |
|------------------------|---------------|--------------------------------------------------------------------------------------------|
| total_energy_import_t1 | Number:Energy | The most recently reported total imported energy in kWh by counter 1. |
| total_energy_import_t2 | Number:Energy | The most recently reported total imported energy in kWh by counter 2. |
| total_energy_export_t1 | Number:Energy | The most recently reported total exported energy in kWh by counter 1. |
| total_energy_export_t2 | Number:Energy | The most recently reported total exported energy in kWh by counter 2. |
| active_power | Number:Power | The current net total power in W. It will be below 0 if power is currently being exported. |
| active_power_l1 | Number:Power | The current net total power in W for phase 1. |
| active_power_l2 | Number:Power | The current net total power in W for phase 2. |
| active_power_l3 | Number:Power | The current net total power in W for phase 3. |
| total_gas | Number:Volume | The most recently reported total imported gas in m^3. |
| gas_timestamp | DateTime | The time stamp of the total_gas measurement. |
Example of configuration through a .items file:
```
Number:Energy Energy_Import_T1 "Imported Energy T1 [%.0f kWh]" {channel="homewizard:p1_wifi_meter:my_meter:total_energy_import_t1" }
Number:Power Active_Power_L1 "Active Power Phase 1 [%.1f W]" {channel="homewizard:p1_wifi_meter:my_meter:active_power_l1" }
DateTime Gas_Update "Gas Update Time [%1$tH:%1$tM]" {channel="homewizard:p1_wifi_meter:my_meter:gas_timestamp" }
```

View File

@ -192,6 +192,7 @@ Currently the miio binding supports more than 280 different models.
| Device | ThingType | Device Model | Supported | Remark |
|------------------------------|------------------|------------------------|-----------|------------|
| AUX Smart Air Conditioner | miio:unsupported | aux.aircondition.v1 | No | |
| Qingping Air Monitor Lite | miio:basic | [cgllc.airm.cgdn1](#cgllc-airm-cgdn1) | Yes | Identified manual actions for execution<br />`action{"did":"settings-set-start-time","siid":9,"aiid":2,"in":[2.0]}`<br />`action{"did":"settings-set-end-time","siid":9,"aiid":3,"in":[3.0]}`<br />`action{"did":"settings-set-frequency","siid":9,"aiid":4,"in":[4.0]}`<br />`action{"did":"settings-set-screen-off","siid":9,"aiid":5,"in":[5.0]}`<br />`action{"did":"settings-set-device-off","siid":9,"aiid":6,"in":[6.0]}`<br />`action{"did":"settings-set-temp-unit","siid":9,"aiid":7,"in":[7.0]}`<br />Please test and feedback if they are working to they can be linked to a channel. |
| Mi Multifunction Air Monitor | miio:basic | [cgllc.airmonitor.b1](#cgllc-airmonitor-b1) | Yes | |
| Qingping Air Monitor | miio:basic | [cgllc.airmonitor.s1](#cgllc-airmonitor-s1) | Yes | |
| Mi Universal Remote | miio:unsupported | chuangmi.ir.v2 | No | |
@ -521,6 +522,25 @@ note: the ADVANCED `actions#commands` and `actions#rpc` channels can be used to
e.g. `openhab:send actionCommand 'upd_timer["1498595904821", "on"]'` would enable a pre-configured timer. See https://github.com/marcelrv/XiaomiRobotVacuumProtocol for all known available commands.
### Qingping Air Monitor Lite (<a name="cgllc-airm-cgdn1">cgllc.airm.cgdn1</a>) Channels
| Channel | Type | Description | Comment |
|----------------------|----------------------|------------------------------------------|------------|
| actions | String | Actions | Value mapping ["settings-set-start-time"="Set Start Time","settings-set-end-time"="Set End Time","settings-set-frequency"="Set Frequency","settings-set-screen-off"="Set Screen Off","settings-set-device-off"="Set Device Off","settings-set-temp-unit"="Set Temp Unit"] |
| relative_humidity | Number:Dimensionless | Environment - Relative Humidity | |
| pm2_5_density | Number:Density | Environment - PM2 5 Density | |
| pm10_density | Number:Density | Environment - PM10 Density | |
| temperature | Number:Temperature | Environment - Temperature | |
| co2_density | Number:Density | Environment - CO2 Density | |
| battery_level | Number:Dimensionless | Battery - Battery Level | |
| charging_state | Number | Battery - Charging State | Value mapping ["1"="Charging","2"="Not charging","3"="Not chargeable"] |
| voltage | Number:ElectricPotential | Battery - Voltage | |
| mac | String | Mac - Mac | |
| monitoring_frequency | Number:Time | Settings - Monitoring Frequency | Value mapping ["1"="Second","60"="Second","300"="Second","600"="Second","0"="Null"] |
| screen_off | Number:Time | Settings - Screen Off | Value mapping ["15"="Second","30"="Second","60"="Second","300"="Second","0"="Null"] |
| device_off | Number:Time | Settings - Device Off | Value mapping ["15"="Minute","30"="Minute","60"="Minute","0"="Null"] |
| tempature_unit | String | Settings - Tempature Unit | |
### Mi Multifunction Air Monitor (<a name="cgllc-airmonitor-b1">cgllc.airmonitor.b1</a>) Channels
| Channel | Type | Description | Comment |
@ -4959,6 +4979,28 @@ Additionally depending on the capabilities of your robot vacuum other channels m
### Qingping Air Monitor Lite (cgllc.airm.cgdn1) item file lines
note: Autogenerated example. Replace the id (airm) in the channel with your own. Replace `basic` with `generic` in the thing UID depending on how your thing was discovered.
```
Group G_airm "Qingping Air Monitor Lite" <status>
String actions "Actions" (G_airm) {channel="miio:basic:airm:actions"}
Number:Dimensionless relative_humidity "Environment - Relative Humidity" (G_airm) {channel="miio:basic:airm:relative_humidity"}
Number:Density pm2_5_density "Environment - PM2 5 Density" (G_airm) {channel="miio:basic:airm:pm2_5_density"}
Number:Density pm10_density "Environment - PM10 Density" (G_airm) {channel="miio:basic:airm:pm10_density"}
Number:Temperature temperature "Environment - Temperature" (G_airm) {channel="miio:basic:airm:temperature"}
Number:Density co2_density "Environment - CO2 Density" (G_airm) {channel="miio:basic:airm:co2_density"}
Number:Dimensionless battery_level "Battery - Battery Level" (G_airm) {channel="miio:basic:airm:battery_level"}
Number charging_state "Battery - Charging State" (G_airm) {channel="miio:basic:airm:charging_state"}
Number:ElectricPotential voltage "Battery - Voltage" (G_airm) {channel="miio:basic:airm:voltage"}
String mac "Mac - Mac" (G_airm) {channel="miio:basic:airm:mac"}
Number:Time monitoring_frequency "Settings - Monitoring Frequency" (G_airm) {channel="miio:basic:airm:monitoring_frequency"}
Number:Time screen_off "Settings - Screen Off" (G_airm) {channel="miio:basic:airm:screen_off"}
Number:Time device_off "Settings - Device Off" (G_airm) {channel="miio:basic:airm:device_off"}
String tempature_unit "Settings - Tempature Unit" (G_airm) {channel="miio:basic:airm:tempature_unit"}
```
### Mi Multifunction Air Monitor (cgllc.airmonitor.b1) item file lines
note: Autogenerated example. Replace the id (airmonitor) in the channel with your own. Replace `basic` with `generic` in the thing UID depending on how your thing was discovered.

View File

@ -64,6 +64,16 @@ A marker on a floor plan
Size of the icon in pixels (40 by default)
</PropDescription>
</PropBlock>
<PropBlock type="INTEGER" name="iconWidth" label="Icon Width">
<PropDescription>
Width of the icon in pixels (for openHAB icons only, 40 by default)
</PropDescription>
</PropBlock>
<PropBlock type="INTEGER" name="iconHeight" label="Icon Height">
<PropDescription>
Height of the icon in pixels (for openHAB icons only, 40 by default)
</PropDescription>
</PropBlock>
<PropBlock type="TEXT" name="iconColor" label="Icon Color">
<PropDescription>
Color of the icon (for Framework7/Material icons); use expression for dynamic colors

View File

@ -0,0 +1,132 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="homewizard"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<thing-type id="p1_wifi_meter">
<label>HomeWizard Wi-Fi P1 Meter</label>
<description>This thing provides the measurement data that is available through the http interface of the HomeWizard
Wi-Fi P1 Meter.</description>
<channels>
<channel id="total_energy_import_t1" typeId="total_energy_import_t1"/>
<channel id="total_energy_import_t2" typeId="total_energy_import_t2"/>
<channel id="total_energy_export_t1" typeId="total_energy_export_t1"/>
<channel id="total_energy_export_t2" typeId="total_energy_export_t2"/>
<channel id="active_power" typeId="active_power"/>
<channel id="active_power_l1" typeId="active_power_l1"/>
<channel id="active_power_l2" typeId="active_power_l2"/>
<channel id="active_power_l3" typeId="active_power_l3"/>
<channel id="total_gas" typeId="total_gas"/>
<channel id="gas_timestamp" typeId="gas_timestamp"/>
</channels>
<properties>
<property name="meterModel">Unknown</property>
</properties>
<config-description>
<parameter name="ipAddress" type="text" required="true">
<label>Network Address</label>
<description>The IP or host name of the P1 Meter.</description>
<context>network-address</context>
</parameter>
<parameter name="refreshDelay" type="integer" min="1" unit="s">
<label>Refresh Interval</label>
<description>The refresh interval in seconds for polling the P1 Meter.</description>
<default>5</default>
</parameter>
</config-description>
</thing-type>
<channel-type id="total_energy_import_t1">
<item-type>Number:Energy</item-type>
<label>Total Imported Energy Counter 1</label>
<description>This channel provides the most recently reported total imported energy in kWh by counter 1, most commonly
used for import during the night or weekend.</description>
</channel-type>
<channel-type id="total_energy_import_t2">
<item-type>Number:Energy</item-type>
<label>Total Imported Energy Counter 2</label>
<description>
This channel provides the most recently reported total imported energy in kWh by counter 2, most commonly
used for import during the day.
</description>
</channel-type>
<channel-type id="total_energy_export_t1">
<item-type>Number:Energy</item-type>
<label>Total Exported Energy Counter 1</label>
<description>
This channel provides the most recently reported total exported energy in kWh by counter 1, most commonly
used for export during the night or weekend.
</description>
</channel-type>
<channel-type id="total_energy_export_t2">
<item-type>Number:Energy</item-type>
<label>Total Exported Energy Counter 2</label>
<description>
This channel provides the most recently reported total exported energy in kWh by counter 2, most commonly
used for export during the day.
</description>
</channel-type>
<channel-type id="active_power">
<item-type>Number:Power</item-type>
<label>Current Total Net Power</label>
<description>
This channel provides the current net total power in W. It will be below 0 if power is currently being
exported.
</description>
</channel-type>
<channel-type id="active_power_l1">
<item-type>Number:Power</item-type>
<label>Current Phase 1 Net Power</label>
<description>
This channel provides the current net phase 1 power in W. It will be below 0 if power is currently being
exported.
</description>
</channel-type>
<channel-type id="active_power_l2">
<item-type>Number:Power</item-type>
<label>Current Phase 2 Net Power</label>
<description>
This channel provides the current net phase 2 power in W. It will be below 0 if power is currently being
exported. It will be 0 for single phase systems.
</description>
</channel-type>
<channel-type id="active_power_l3">
<item-type>Number:Power</item-type>
<label>Current Phase 3 Net Power</label>
<description>
This channel provides the current net phase 3 power in W. It will be below 0 if power is currently being
exported. It will be 0 for single phase systems.
</description>
</channel-type>
<channel-type id="total_gas">
<item-type>Number:Volume</item-type>
<label>Total Imported Gas</label>
<description>
This channel provides the most recently reported total imported gas in m^3. It does not get updated as
frequently as the data in the other channels, the gas_timestamp channel provides the time stamp of the most recent
update.
</description>
</channel-type>
<channel-type id="gas_timestamp">
<item-type>DateTime</item-type>
<label>Gas Update Time Stamp</label>
<description>
This channel provides the time stamp of the total_gas measurement.
</description>
</channel-type>
</thing:thing-descriptions>

View File

@ -119,6 +119,22 @@ reliably work on 64 bit.
On x86 hardware, 64 bit is the standard.
### Networking
The scripted use (i.e. the non-image version) of openHABian does not change anything about your OS' networking setup (except if you deploy a VPN from the menu, of course) so you have to take care of that yourself.
For image based installations, openHABian re-uses the TCP/IP networking setup Raspberry Pi OS is coming with. This is documented over here:
https://www.raspberrypi.org/documentation/configuration/tcpip/.
See also there what that `169.*` IP address is about in case you see it on your system (it means DHCP didn't work).
A properly working DHCP server is a mandatory prerequisite to openHABian networking setup.
Note it is NOT supported to setup openHABian with a static IP address as described in the Raspberry Pi OS documentation as that can interfere with openHABian functionality.
If you want to have a fixed address, configure your DHCP server to respond with that IP to requests from your Pi's MAC address.
When you boot a flashed image for the first time, openHABian will setup and use the Ethernet port if that one is connected with a cable to your LAN.
It'll also use the `wifi_ssid` and `wifi_password` parameters from `/etc/openhabian.conf` to determine whether and how to setup the Wi-Fi interface.
After these stages it checks for connectivity to the Internet and if that fails, it'll open a [Wi-Fi hotspot](openhabian.md#Wi-Fi Hotspot) that lets you manually connect your system to a WLAN (Wi-Fi) of yours to jumpstart networking.
Remember that once the hotspot is started, it'll hide once you have successfully used it to connect your Wi-Fi interface but it'll return should your Wi-Fi connectivity break down.
## Raspberry Pi prepackaged SD card image
**Flash, plug, wait, enjoy:**
@ -363,12 +379,12 @@ This may or may not work for your mobile browser as it requires Bonjour/ZeroConf
If you cannot connect to this address, go to `http://10.41.0.1`.
On that page you can select the SSID of the network you want to connect your system to.
Provide the password and press the button.
Note that as soon as you do, the wlan0 IP address changes so your mobile browser will not be able to provide you any feedback if that worked out.
Note that as soon as you do, the wlan0 IP address of your system changes so your mobile browser will not be able to provide you any feedback if that worked out.
Try to ping the new system's hostname (default is `openhabian`) or check DHCP on your router if your openHABian system appeared there.
For more information on this feature see [comitup-cli](https://davesteele.github.io/comitup/).
You can use `sudo comitup-cli` inside openHABian to change networks and eventually remove network credentials.
Note the hotspot may not only become available during installation: it will remain on standby and will show up again every time your `wlan0` interface is losing connectivity.
The hotspot feature is known to work on RPi-0W, RPi-3, and RPi-4 but is known to often expose problems with Wi-Fi USB adapters.
For more information on hotspot functions see [comitup-cli](https://davesteele.github.io/comitup/). Most behavior can be tweaked by setting parameters (such as a default password) in `/etc/comitup.conf`.
The hotspot feature is known to work on RPi0W, RPi3, and RPi4 but is known to often expose problems with Wi-Fi USB adapters.
#### Disable zram