Skip to main content

This is a simple blynk HTTP/HTTPS API wrapper.

Project description

# blynkapi

This is a simple blynk HTTP/HTTPS API wrapper.

### Introduction
This library created for simple using [Blynk API](http://docs.blynkapi.apiary.io/#reference/0/pin-actions) and manage your project via python. It's simple one class lib which used `urllib2` for requests.

You can also:
- Read/write pin value
- Check hardware network status
- Check application network status
- Send push notification
- Send email
- Get pin history data
- Get QR for project cloning
- Get project info
- Query API

### Installation

Install via pip
```bash
pip install blynkapi
```
after installation import it in your code
```python
from blynkapi import Blynk
```

Or simple copy `blynkapi/Blynk.py` to your main python program dir and import it
```python
from Blynk import *
```

### Using
```python
# if you install it from pip, else use `from Blynk import *`
from blynkapi import Blynk
# vars
auth_token = "sdjflksjflkdsjfkldsjfkldfkldjflk"

# create objects
room_light = Blynk(auth_token, pin = "V3")
kitchen_light = Blynk(auth_token, pin = "V4")
house_door = Blynk(auth_token, pin = "V5")
amp_power = Blynk(auth_token, pin = "V6")

# get current status
res = room_light.get_val()
print res

# set pin value (one)
amp_power.set_val(["120"])

# set pin value to 1
room_light.on()
# set pin value to 0
room_light.off()
```

### Available methods

All methods return values from API or error if it fixed. For detailed description of returning values and scheme read official [Blynk API guide] (http://docs.blynkapi.apiary.io/#reference)

Creating main object
```python
Blynk(token, server, protocol, port, pin, value)
```
- `token` - Your project token
- `server` - Blynk server for API requests, default "blynk-cloud.com"
- `protocol` - http or https, default "http"
- `port` - Your Blynk server API port, default "8080"
- `pin` - Pin for working with, default "None"
- `value` - Value for method get_val, default "None"

To turn pin on (set val "1" to pin)
```python
on()
```

To turn pin off (set val "0" to pin)
```python
off()
```

To set your value for pin
```python
set_val(value)
```
- `value` - Custom value in list ["x"] or multiple values in list ["x", "y"]. [Details] (http://docs.blynkapi.apiary.io/#reference/0/write-pin-value-via-put/write-pin-value-via-put)

To get data from pin
```python
get_val()
```

Send push notification
```python
push(value)
```
- `value` - String no more than 255 chars.

Send email
```python
email(to, title, subj)
```
- `to` - String
- `title` - String
- `subj` - String

Check hardware status (connection to server)
```python
hw_status()
```

Check app status (connection to server)
```python
app_status()
```

Get pin history
```python
history()
```

Get QR image
```python
qr()
```

Get project info For details see [docs] (http://docs.blynkapi.apiary.io/#reference/0/get-project/get-project)
```python
get_project()
```

Query API. For details see [docs] (http://docs.blynkapi.apiary.io/#reference/0/query-api/query-api)
```python
query_api(groupBy, aggregation, pin, value)
```
- `groupBy` - String
- `aggregation` - String
- `pin` - String
- `value` - String



### Todos

- Write Tests

License
----

MIT

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

blynkapi-0.1.8.tar.gz (4.6 kB view details)

Uploaded Source

File details

Details for the file blynkapi-0.1.8.tar.gz.

File metadata

  • Download URL: blynkapi-0.1.8.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for blynkapi-0.1.8.tar.gz
Algorithm Hash digest
SHA256 bee950283582a584ea366b97b5ba65fae2689616287859834c8323754c749aa2
MD5 fce04c76cc8831f067701cf7391bdf74
BLAKE2b-256 6ee13eb2a5641fc52d0d4f5b840f4e0805e9d356caeb913933188d4cab85c6dd

See more details on using hashes here.

Supported by

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