A wrapper for the Blue Current websocket api
Project description
Blue Current Api
Python wrapper for the blue current api
The library is an asyncio-driven library that interfaces with the Websocket API provided by Blue Current. This was made for the Blue Current Home Assistant integration.
Usage
Requirements
- Python 3.11 or newer
- websockets
- pytz
Installation
pip install bluecurrent-api
Api token
Using this library requires a Blue Current api token. You can generate one in the Blue Current driver portal.
Example
from bluecurrent_api import Client
import asyncio
async def main():
api_token = 'api_token'
client = Client()
# data receiver
async def on_data(data):
print('received: ', data)
# validate and set token.
await client.validate_api_token(api_token)
# example requests
async def requests():
await client.get_charge_points()
await asyncio.sleep(10)
await client.disconnect()
# connect and send requests
await asyncio.gather(
client.connect(on_data),
requests()
)
asyncio.run(main())
Implemented methods
The methods validate_token and get_email are stand-alone and are to be used before connecting to the websocket with connect().
await validate_token(api_token) -> str
- Validates the given token.
await get_email() -> str
- Returns the account's email.
await connect(receiver)
- Connects to the websocket.
- Calls get_charge_points and get_charge_cards when connection is established.
is_connected() -> bool
- Returns if the client is connected
await wait_for_charge_points()
- Waits until chargepoints are received.
get_next_reset_delta() -> TimeDelta
- Returns the timedelta to the next request limit reset (00:00 Europe/Amsterdam).
await disconnect()
- Stops the connection.
Data
await get_charge_points()
- Gets the chargepoints
await get_charge_cards()
- Returns the users charge cards.
await get_status(evse_id)
- Gets the status from a chargepoint.
await get_settings(evse_id)
- Gets the setting states from a chargepoint.
await get_grid_status(evse_id)
- Gets the grid status from a chargepoint.
Settings
await set_linked_charge_cards_only(evse_id, value)
- Sets set_linked_charge_cards_only.
await set_plug_and_charge(evse_id, value)
- Sets set_plug_and_charge.
await block(evse_id, value)
- Blocks or unblocks a charge point.
Actions
await reset(evse_id)
- Resets the chargepoint.
await reboot(evse_id)
- Reboots the chargepoint.
await start_session(evse_id card_uid)
- Starts a charge session.
await stop_session(evse_id)
- Stops a charge session.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
bluecurrent-api-1.2.2.tar.gz
(13.3 kB
view hashes)
Built Distribution
Close
Hashes for bluecurrent_api-1.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76ea3b6e1a60f92c66c322bf9365636d4b1b83ba00cc4765abf9d6ed08080025 |
|
MD5 | 986bc47f1ab4d4bcf335a1ad54bb6fca |
|
BLAKE2b-256 | 0341ad21e1361728f26c72e0efe7af7e8806ab27b061dbd00f40f1182b562398 |