API wrapper for Smappee
## Create a new connection by supplying your Smappee client id and secret
`s = smappy.Smappee(client_id, client_secret)`
## Authenticate using a Smappee username and password
Re-authentication using the refresh token is done automatically when the access token has expired.
## API Requests
7 API requests are supported. The methods return the parsed JSON response as a dict.
### Get Service Locations
### Get Service Location Info
### Get Consumption
- `s.get_consumption(service_location_id, start, end, aggregation)`
- `s.get_sensor_consumption(service_location_id, sensor_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)`
- `s.actuator_on(self, service_location_id, actuator_id, duration)`
- `s.actuator_off(self, service_location_id, actuator_id, duration)`
duration = 300,900,1800 or 3600 - specifying the time in seconds the actuator
should be turned on or off. Any other value results in turning on or off for an
undetermined period of time.
## Consumption as Pandas DataFrame
Get consumption values in a Pandas Data Frame
- To get total Electricity consumption and Solar production, use:
`s.get_consumption_dataframe(service_location_id, start, end, aggregation, localize)`
- To get consumption for a specific sensor, include a sensor id:
`s.get_consumption_dataframe(service_location_id, start, end, aggregation, localize, sensor_id)`
Use the localize flag to get localized timestamps.
# Simple Smappee
If you have no client id, client secret, refresh token etc, for instance if everything concerning oAuth is handed off
to a different process like a web layer. This object only uses a given access token. It has no means of refreshing it
when it expires, in which case the requests will raise errors.
`ss = SimpleSmappee(access_token)`
It has the same methods as the normal Smappee class, except authorization and re-authorization will not work.
Future development may include:
Request error catching and handling.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.