Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 4.96 KB

README.md

File metadata and controls

83 lines (58 loc) · 4.96 KB
Raw

SPAN integration for HomeAssistant/HACS

Home Assistant Integration for Span smart panel.

hacs_badge

This integration should not have any negative impact on your Span installation, but as Span has not published a documented API, we cannot guarantee this will work for you, or that will not break as your panel is updated. The author(s) will try to keep this integration working, but cannot provide technical support for either Span or your homes electrical system.

Installation

  1. Install HACS
  2. Go to HACS Integrations section
  3. In the lower right click "Explore & Download Repositories"
  4. Search for Span
  5. Select the "Span Panel" result
  6. Select "Download"
  7. Restart Home Assistant
  8. In the Home Assistant UI go to Settings
  9. Click Devices & Services
  10. Click + Add Integration
  11. Search for "Span"
  12. Enter the IP of your Span Panel to begin setup, or select the automatically discovered panel if it shows up.

Auth Token

The SPAN api requires an auth token. If you already have one from some previous setup, you can reuse it. If you don't already have a token (most people), you just need to prove that you are physically near the panel, and then the integration can get its own token.

Proof of Proximity

Simply open the door to your Span Panel and press the door sensor button at the top 3 times in succession. The lights ringing the frame of your panel should blink momentarily, and the Panel will now be "unlocked" for 15 minutes (it may in fact be significantly longer, but 15 is the documented period). While the panel is unlocked, it will allow the integration to create a new auth token.

Technical Details

These details were provided by a SPAN engineer, and have been implemented in the integration. They are documented here in the hope someone may find them useful.

To get an auth token:

  1. Make a POST to {Span_Panel_IP}/api/v1/auth/register with a JSON body of {"name": "home-assistant-UNIQUEID", "description": "Home Assistant Local Span Integration"}.
    • Use a unique value for UNIQUEID. Six random alphanumeric characters would be a reasonable choice. If the name conflicts with one that's already been created, then the request will fail.
    • Example via CLI: curl -X POST https://192.168.1.2/api/v1/auth/register -H 'Content-Type: application/json' -d '{"name": "home-assistant-123456", "description": "Home Assistant Local Span Integration"}'
  2. If the panel is already "unlocked", you will get a 2xx response to this call containing the "accessToken". If not, then you will be prompted to open and close the door of the panel 3 times, once every two seconds, and then retry the query.
  3. Store the value from the "accessToken" property of the response. (It will be a long string, such as eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" for example). This is the token which should be included with all future requests.
  4. Send all future requests with the HTTP header "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" (Remember, this is just a dummy example token!)

(If you have multiple Span Panels, you will need to repeat this process for each panel, as tokens are only accepted by the panel that generated them.)

If you have this auth token, you can entere it in the "Existing Auth Token" flow in the UI menu.

Devices & Entities

This integration will a device for your span panel. This devices will have entities for:

  • Circuits
    • On/Off Switch
    • Priority Selector
    • Power Usage
  • Network Connectivity (Wi-Fi, Wired, & Cellular)
  • Door State

Entity Precision

The power sensors provided by this add-on report with the exact precision from the SPAN panel, which may be more decimal places than you will want for practical purposes. By default the sensors will display with precision 2 (e.g. 0.00).

You can change the display precision for any entity in HomeAssistant via Settings -> Devices & Services -> Entities tab. find the entity you would like to change in the list and click on it, then click on the gear wheel in the top right. Select the precision you prefer from the "Display Precision" menu and then press UPDATE.

License

This integration is published under the MIT license.

Contributing & Issues

If you have a problem, feel free to open an issue, but please know issues regarding your network, Span configuration, or home electrical system are outside of our purview. For those capable, please consider opening even a low quality pull request when possible, as we're generally very happy to have a starting point when making a change.