Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/harperreed/pyawair
a very simple python class to access the (private) awair api
https://github.com/harperreed/pyawair
air-quality api awair home-automation internet-of-things iot iot-device python
Last synced: about 3 hours ago
JSON representation
a very simple python class to access the (private) awair api
- Host: GitHub
- URL: https://github.com/harperreed/pyawair
- Owner: harperreed
- License: mit
- Created: 2017-12-21T05:06:43.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-31T00:40:07.000Z (almost 6 years ago)
- Last Synced: 2024-05-08T00:03:32.328Z (6 months ago)
- Topics: air-quality, api, awair, home-automation, internet-of-things, iot, iot-device, python
- Language: Python
- Size: 6.84 KB
- Stars: 25
- Watchers: 4
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pyawair
A very simple python class to access the (private) awair api
## Why
I have a few Awair devices around my house and they are great. I like how they look, and the service that they provide. The only issue I have with teh device and service is that Awair doesn't offer a public API at the consumer level. I cannot incorporate the data that Awair is collecting into my dashboards and home automation.
I spent a bit of time looking into how to get access to their enterprise API. APparently you have to pay for it and have five or more devices. Both of those seemed untenable currently. The enterprise product looks really neat so I hope that one day I have an office that can use it!
This API is what powers their iOS app and is robust and well designed.
## Example
The API is super straightforward.
Import the class
```python
from awair import awair
```
You can isntantiate the class by logging in using your username and password
```python
username = "[email protected]"
password = "very long and secure password"
api = awair(username, password)
```
If you already have an access token, you can use that instead of username and password. This will skip the login process
```python
access_token = "XXXXX"
api = awair(username, password, access_token)
```
Once you are logged in, you can grab all the devices
```python
devices = api.devices()
for device in devices: #Let's iterate through devices
print(device) #Print the device
print("Let's grab the weather")
weather = api.weather(latitude=device['latitude'],longitude=device['longitude'])
print(weather)
print("Timeline from yesterday to today")
timeline = api.timeline(device['id'], yesterday_isoformat_string, today_isoformat_string)
print("Event score") #I have no idea what the event score is - but it is full of data!
print api.events_score(device['id'])
```
You can also access your in app "inbox" and get sleep reports
```python
device_id = "00000" #your device id from the device in the device list
inbox = api.inbox() #Grab inbox
for message in inbox: #iterate through messages in inbox
print message #Print the message
if message['title']=='Sleep Report':
print("Printing sleep report for " + message['timestamp'])
print(api.sleep_report(device_id, message['timestamp']))
```
## Warning
Obviously this is not a supported API. You should not use this. You should work with Awair and use their enterprise offering.
If that offering doesn't work for you (much like it doesn't yet work for me) - then YMMV with this. I expect that they will change their api frequently (notice the versions in the URL).
## Yay!
I hope this is helpful. It would be pretty easy to use this to create a v nice custom component for home assistant. They API has enough resolution that you could really react to changes when they happen.
If you have questions or comments - hit me up on [twitter](https://twitter.com/harper/) or [email](mailto:[email protected]).