Skip to main content

A python API wrapper for Smappee

Project description

# Smappy API wrapper for Smappee

See https://smappee.atlassian.net/wiki/display/DEVAPI/API+Methods

## Create a new connection by supplying your Smappee client id and secret s = smappy.Smappee(client_id=’<your client id>’, client_secret=’<your client secret>’)

## Authenticate using a Smappee username and password s.authenticate(username=’<your username>’, password=’<your password>’)

Re-authentication using the refresh token is done automatically when the authorization token has expired.

## API Requests 4 API requests are supported. The methods return the parsed JSON response as a dict.

### Get Service Locations s.get_service_locations()

### Get Service Location Info s.get_service_location_info(service_location_id)

### Get Consumption s.get_consumption(service_location_id, start, end, aggregation)

Start & End accept epoch (in milliseconds), datetime and pandas timestamps

Aggregation: 1 = 5 min values (only available for the last 14 days), 2 = hourly values, 3 = daily values, 4 = monthly values, 5 = quarterly values

### Get Events s.get_events(service_location_id, appliance_id, start, end, max_number)

# Future Future development may include:

‘Authorization key only’-mode. For when you don’t have direct access to user names passwords or even client id and secret. When the python part of your code is running as a job in the back-end for example.

Request error catching and handling.

Output consumption as Pandas Dataframe

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

smappy-0.0.2.tar.gz (5.1 kB view hashes)

Uploaded Source

Built Distribution

smappy-0.0.2-py3-none-any.whl (5.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page