Skip to content

Commit 134b7bb

Browse files
committed
documentation updates
1 parent 7305f20 commit 134b7bb

File tree

3 files changed

+28
-11
lines changed

3 files changed

+28
-11
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
*.DS_Store
22
*__pycache__*
33
*.idea
4+
*.vscode

docs/source/data.rst

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This includes
1212

1313
* Energy imported from the grid
1414
* Total home energy usage
15-
* Energy exported to the grid (from solar)
15+
* Energy exported to the grid (from solar , if available)
1616
* Total solar production
1717

1818
as well as the corresponding instantaneous power consumption/production.
@@ -40,14 +40,13 @@ Each plug exposes 6 entities reflecting the different measurements made by the p
4040

4141
* Power
4242
* Total Energy Consumption
43-
* Active Current
44-
* Reactive Current
45-
* Apparent Current
43+
* Current
4644
* Voltage
4745

48-
Of these only the power and total energy are commonly of interest, and future
49-
releases intend to make the others optional inclusions when the integration
50-
is configured.
46+
The current displayed in the integration represents active current only, but the Powersensor
47+
api exposes reactive and apparent current as well. Future release plans intend to expose
48+
all available data, with reactive and apparent current being optional during the configuration
49+
step for the integration.
5150

5251
The plug readings typically update every second.
5352

@@ -66,8 +65,17 @@ showing up as expected, use the mobile app to check which plug it's trying
6665
to relay though, and the signal strength. If necessary, relocate a plug to
6766
somewhere closer to the sensor to improve the signal strength.
6867

68+
.. note::
69+
Water sensors are not fully supported in the integration at this time.
70+
Water sensors will appear in the integration, but will only report
71+
sensor battery level. Development for water sensors is on-going and
72+
we hope to provide full support in future.
73+
6974
Automations
7075
-----------
7176

7277
Any of the plug, sensor or virtual household entities can be used in
73-
automation workflows.
78+
automation workflows. To exercise control of other devices in your
79+
household, first install any relevant integrations for those devices.
80+
Then follow the usual Home Assistant steps for setting up rules:
81+
Settings->Automations & Scenes and +Create Automation

docs/source/installation.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Before installing this integration, ensure you have:
1515

1616
From Source
1717
------------
18-
Clone or download this repo e.g.
18+
If you have commandline access to the machine running Home Assistant, simply clone or download this repo e.g.
1919

2020
.. code-block:: bash
2121
@@ -29,5 +29,13 @@ When launching homeassistant, e.g.
2929
hass --config ./config
3030
3131
Home assistant should automatically discover powersensor devices on the same network.
32-
Follow the links for Settings/Devices&Services. At the top you should be prompted add ``powersensor`` to your
33-
homeassistant instance.
32+
Follow the links for Settings/Devices & Services. At the top you should be prompted add ``powersensor`` to your
33+
homeassistant instance. Alternatively, you can can click the +Add Integration button and search for ``powersensor``
34+
35+
HA OS
36+
-----
37+
If you are installing on a dedicated device running HA OS such as Home Assistant Green, you may need to take a few extra steps.
38+
If you have ssh access to the box, you can follow the command line instructions above. However, the recommended
39+
option for most users is to install the `Samba Add-on <https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-samba-add-on>`_.
40+
Once installed, you should be able to mount your Home Assistant root directory as a network drive. From there,
41+
clone or download this repo and copy the ``powersensor`` directory to your config folder.

0 commit comments

Comments
 (0)