Home Assistant custom integration to fetch data from Powerpal

Overview

Powerpal custom component for Home Assistant

GitHub Release GitHub Activity

hacs

Component to integrate with powerpal.

This repository and integration is not affiliated with Powerpal.

This component will set up the following platforms and entities.

Platform Description
sensor Show info from Powerpal Readings API.
Entity Description
sensor.powerpal_live_consumption Current reading from Powerpal Readings API (updated every minute).
sensor.powerpal_total_consumption Total consumption recorded by Powerpal - entity can be used in Energy Dashboard.

sensor

energy

Automatic Installation

  1. Install HACS
  2. Within HA go to HACS > Integrations > ... (in top right corner) > Custom Repositories
  3. Add URL: https://github.com/mindmelting/hass-powerpal, Category: Integration
  4. Go to the integrations page inside your home assistant install
  5. Search for Powerpal
  6. Install, enter your Powerpal API Authorization Key and Powerpal Device ID.

Manual Installation

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called powerpal.
  4. Download all the files from the custom_components/powerpal/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for Powerpal

Using your HA configuration directory (folder) as a starting point you should now also have this:

custom_components/powerpal/translations/en.json
custom_components/powerpal/__init__.py
custom_components/powerpal/config_flow.py
custom_components/powerpal/const.py
custom_components/powerpal/manifest.json
custom_components/powerpal/sensor.py

Configuration is done in the UI

Contributions are welcome

If you want to contribute to this please read the Contribution guidelines


Comments
  • How to obtain authorisation key

    How to obtain authorisation key

    Is your feature request related to a problem? Please describe. It seems very difficult to obtain the authorisation key.

    Describe the solution you'd like Please provide a solution on how to obtain this authorisation key simply

    question 
    opened by cdouet 8
  • add python script to retrieve apikey over BLE

    add python script to retrieve apikey over BLE

    After reverse engineering the Powerpal BLE comms I didn't think to bother with any of the REST API because that had been covered pretty well by a couple of other github projects.

    But on coming back to it I realised that there was one step that is still a bit of a pain and mystery, retrieving the apikey! (though I believe now you can maybe apply for it, this is probably still more convenient)

    The Apikey is actually stored locally on the Powerpal, behind the 'UUID' (59DA0009-12F4-25A6-7D4F-55961DCE4205) characteristic.

    This is a super simple python script to retrieve it, and only requires the Powerpal MAC address (can easily be found by scanning for bluetooth devices), and the pairing code given to you with your Powerpal (can also be found within the Powerpal Application)

    I don't currently have access to a Powerpal to test this on, so would really appreciate if you could give it a go and let me know if it works (it's also possible the data that comes back might need to have it's bytes reversed)

    Can run by adding your mac and pairing key as arguments, or by changing them in the script: python3 utils/retrieve_api_key.py "12:34:56:78:90:AB" 123123

    opened by WeekendWarrior1 3
  • Consumption chart seems to be linked to time of sync, not time of usage

    Consumption chart seems to be linked to time of sync, not time of usage

    Version of the custom_component

    f7e8b30

    Describe the bug

    The Total Consumption chart seems to be calculated based on the time of syncing the data, not the actual time of usage. This shows it fairly clearly: image

    Compare with actual usage per hour from Powerpal app: image

    Is this a bug or a limitation of the API?

    opened by maxw3l 3
  • The link to Documentation is incorrect

    The link to Documentation is incorrect

    Version of the custom_component

    Configuration

    
    Add your logs here.
    
    

    Describe the bug

    A clear and concise description of what the bug is.

    The link has a typo in it, missing final "p" in powerpal

    https://github.com/mindmelting/hass-poweral

    Debug log

    
    Add your logs here.
    
    
    opened by tmugan 2
  • Any way to add data from powerpal server prior to the integration installation?

    Any way to add data from powerpal server prior to the integration installation?

    Hi There,

    Thanks so much for this integration.

    Is there a way to load pervious data to HA, prior to having installed the component?

    Obviously I can download the CSV file, but how do Add it to the newly recorded data in HA?

    Thanks in advance

    opened by botts7 2
  • Advice on integration - App and HA totals are out by 1kWh

    Advice on integration - App and HA totals are out by 1kWh

    Hi,

    Firstly thanks for creating this integration, I have been able to get it working within my setup which is great. I am however wanting some advice on how often it communications with 'readings' as it doesn't seem to be 'live' and the total power consumption is out by nearly 1kWh (compared with the app)

    Is there anything I am missed or need to adjust? or is this expected as it's not providing accurate real time data?

    question 
    opened by tgcowell 2
Releases(v0.2.2)
  • v0.2.2(May 28, 2022)

    What's Changed

    • Update to the GitHub URLs by @StephenGoodall in https://github.com/mindmelting/hass-powerpal/pull/11

    New Contributors

    • @StephenGoodall made their first contribution in https://github.com/mindmelting/hass-powerpal/pull/11

    Full Changelog: https://github.com/mindmelting/hass-powerpal/compare/v0.2.1...v0.2.2

    Source code(tar.gz)
    Source code(zip)
  • v0.2.1(Dec 13, 2021)

    What's Changed

    • chore: Update README to advise on usage by @mindmelting in https://github.com/mindmelting/hass-powerpal/pull/6
    • chore: Update to use extra state attributes by @mindmelting in https://github.com/mindmelting/hass-powerpal/pull/9

    Full Changelog: https://github.com/mindmelting/hass-powerpal/compare/v0.2.0-beta...v0.2.1

    Source code(tar.gz)
    Source code(zip)
  • v0.2.0-beta(Oct 5, 2021)

    What's Changed

    • chore: Update to namespaced lib and updated README.md by @mindmelting in https://github.com/mindmelting/hass-powerpal/pull/1
    Source code(tar.gz)
    Source code(zip)
Owner
Lawrence
Lawrence
2D waypoints will be predefined in ROS based robots to navigate to the destination avoiding obstacles.

A number of 2D waypoints will be predefined in ROS based robots to navigate to the destination avoiding obstacles.

Arghya Chatterjee 5 Nov 05, 2022
Intel Realsense t265 into Unreal Engine

t265_UE Intel Realsense t265 into Unreal Engine. Windows only, and Livelink plugin is 4.26.2 only at the moment. Might recompile it for different vers

Bjarke Aagaard 30 Jan 02, 2023
Aqara Camera G3 integration for Home Assistant

Aqara Camera G3 integration for Home Assistant ATTENTION: The component only works after enabled telnet. Only supportd stream. Not support still image

14 Dec 18, 2022
A circle of LEDs

This repository contains all the design files, production files and example code for a simple circular LED display.

Pim de Groot 15 Aug 21, 2022
Tool to create 3D printable terrain with integrated path/road part files (Single material 3d printer)

BACKGROUND This has been an ongoing project of mine for a few months now. I run trails a lot and original the goal was to create a function to combine

9 Apr 26, 2022
Home assiatant Custom component: Camera Archiver

Camera archiver Archive your ftp camera meadia files on other ftp with files renaming and event creation. Event can be used for send information to el

1 Jan 06, 2022
A versatile program that uses the raspberry pi camera and provides it as a service

PiCameleon Is a daemon program meant to provide the RaspberryPi Camera as a service while running according to a configuration.

André Esser 52 Oct 16, 2022
This repo uses a stereo camera and gray-code-based structured light to realize dense 3D reconstruction.

Structured-light-stereo This repo uses a stereo camera and gray-code-based structured light to realize dense 3D reconstruction. . How to use: STEP 1:

FEI 20 Dec 31, 2022
Micropython-wifimanager-esp8266 - Simple Wifi Manager for ESP8266 using MicroPython

micropython-wifimanager-esp8266 Simple Wifi Manager for ESP8266 using MicroPytho

Abhinuv Nitin Pitale 1 Jan 04, 2022
Designed and coded a password manager in Python with Arduino integration

Designed and coded a password manager in Python with Arduino integration. The Program uses a master user to login, and stores account data such as usernames and passwords to the master user. While lo

Noah Colbourne 1 Jan 16, 2022
Rasberry Pie GPIO memory game. Press the corresponding key to the lit LED.

RPie-keyboard-game Rasberry Pie GPIO memory game. Press the corresponding key to the lit LED. Randem LED (general output) is lit up on rasberrypi rand

Shawn Dowling 1 Oct 24, 2021
Sensor of Temperature Feels Like for Home Assistant.

Please ⭐ this repo if you find it useful Sensor of Temperature Feels Like for Home Assistant Installation Install from HACS (recommended) Have HACS in

Andrey 60 Dec 25, 2022
This is a python script to grab data from Zyxel NSA310 NAS and display in Home Asisstant as sensors.

Home-Assistant Python Scripts Python Scripts for Home-Assistant (http://www.home-assistant.io) Zyxel-NSA310-Home-Assistant Monitoring This is a python

6 Oct 31, 2022
Testing out some (stolen) DMA code for RP2040 Micropython

RP2040_micropython_dma testing out some (stolen) DMA code for RP2040 Micropython. Heavy inspiration and some code from https://iosoft.blog/2021/10/26/

2 Dec 29, 2022
Python library for the Phomemo m02s bluetooth thermal printer

Phomemo M02S Python library This is a basic Python library for controlling the Phomemo M02S bluetooth thermal printer. It probably only works on Mac &

Stargirl Flowers 28 Nov 07, 2022
CPU benchmark by calculating Pi, powered by Python3

cpu-benchmark Info: CPU benchmark by calculating Pi, powered by Python 3. Algorithm The program calculates pi with an accuracy of 10,000 decimal place

Alex Dedyura 20 Jan 03, 2023
Lego Mindstorms EV3 and Lego Spike Prime

Lego Mindstorms EV3 and Lego Spike Prime What is FLL? The FIRST LEGO League Challenge Robotics Tournament challenges students from 9 to 16 years old t

Danimar Campos da Costa 1 Nov 14, 2021
Adafruit IO connected smart thermostat based on CircuitPython.

Adafruit IO Thermostat Adafruit IO connected smart thermostat based on CircuitPython. Background and Motivation I have a 24 V Heat-only system with a

Shubham Chaudhary 1 Jan 18, 2022
USB Rubber Ducky with the Rasberry Pi pico microcontroller

pico-ducky Install Install and have your USB Rubber Ducky working in less than 5 minutes. Download CircuitPython for the Raspberry Pi Pico. Plug the d

AnOnYmOus001100 3 Oct 08, 2022
Terkin is a flexible data logger application for MicroPython and CPython environments.

Terkin Data logging for humans, written in MicroPython. Documentation: https://terkin.org/ Source Code: https://github.com/hiveeyes/terkin-datalogger

hiveeyes 45 Dec 15, 2022