Home

Awesome

SWUbanner

Blynk Python Library

This library provides API to connect IoT hardware that supports Micropython/Python to Blynk Cloud and communiate with Blynk apps (iOS and Android). You can send raw and processed sensor data and remotely control anything that is connected to your hardware (relays, motors, servos) from anywhere in the world.

GitHub version GitHub download GitHub stars GitHub issues Build Status License

If you like Blynk - give it a star, or fork it and contribute! GitHub stars GitHub forks

Blynk Banner

Blynk is the most popular Internet of Things platform for connecting hardware to the cloud, designing apps to control them, and managing your deployed devices at scale.

Installation of Blynk Python Library

Installation via python pip

Manual installation

Library can be installed locally from git sources:

git clone https://github.com/blynkkk/lib-python.git
cd lib-python
pip install --user -e .

# sudo pip install -e .  # if installation needed not for current but for all users

Testing

You can run unit tests for cPython version of library (blynklib.py) using the command:

python setup.py test

NOTE Blynklib version <0.2.6 should use pytest-mock<1.11.2. In version 1.11.2 were added restrictions for context manager usage

NOTE: Unit tests for Micropython ENV are not available yet.

Micropython installation

Some hardware platforms can use Micropython package. This is helpful for preliminary testing and debugging of your code outside of real hardware. Supported platforms and related installation docs can be found here.

Features

This library supports Python2, Python3 (blynklib.py) , and Micropython (blynklib_mp.py).

List of available operations:

Quickstart

  1. Install Blynk python library as described above
  2. Install Blynk App: <img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/googleplay.svg" width="18" height="18" /> Google Play | <img src="https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/apple.svg" width="18" height="18" /> App Store
BLYNK_AUTH = '<YourAuthToken>' #insert your Auth Token here

Usage example

import blynklib
# import blynklib_mp as blynklib # micropython import

BLYNK_AUTH = '<YourAuthToken>' #insert your Auth Token here
# base lib init
blynk = blynklib.Blynk(BLYNK_AUTH)
 
# advanced options of lib init
# from __future__ import print_function
# blynk = blynklib.Blynk(BLYNK_AUTH, server='blynk-cloud.com', port=80, ssl_cert=None,
#                        heartbeat=10, rcv_buffer=1024, log=print)

# Lib init with SSL socket connection
# blynk = blynklib.Blynk(BLYNK_AUTH, port=443, ssl_cert='<path to local blynk server certificate>')
# current blynk-cloud.com certificate stored in project as 
# https://github.com/blynkkk/lib-python/blob/master/certificate/blynk-cloud.com.crt
# Note! ssl feature supported only by cPython

# register handler for Virtual Pin V22 reading by Blynk App.
# when a widget in Blynk App asks Virtual Pin data from server within given configurable interval (1,2,5,10 sec etc) 
# server automatically sends notification about read virtual pin event to hardware
# this notification captured by current handler 
@blynk.handle_event('read V22')
def read_virtual_pin_handler(pin):
    
    # your code goes here
    # ...
    # Example: get sensor value, perform calculations, etc
    sensor_data = '<YourSensorData>'
    critilcal_data_value = '<YourThresholdSensorValue>'
        
    # send value to Virtual Pin and store it in Blynk Cloud 
    blynk.virtual_write(pin, sensor_data)
    
    # you can define if needed any other pin
    # example: blynk.virtual_write(24, sensor_data)
        
    # you can perform actions if value reaches a threshold (e.g. some critical value)
    if sensor_data >= critilcal_data_value
        
        blynk.set_property(pin, 'color', '#FF0000') # set red color for the widget UI element 
        blynk.notify('Warning critical value') # send push notification to Blynk App 
        blynk.email(<youremail@email.com>, 'Email Subject', 'Email Body') # send email to specified address
        
# main loop that starts program and handles registered events
while True:
    blynk.run()

Other Examples

Examples can be found here Check them all to get familiar with main Blynk API features.

Core operations:
Raspberry Pi (any):

Read Raspberry Pi guide first.

ESP32

Read ESP32 guide first.

ESP8266

Read ESP8266 guide first.

Memory size limitations

For hardware with limited memory size (ex. ESP8266) you can use frozen modules or frozen bytecode approaches to load blynklib or any other library to hardware.

Read this document to get more information.

Documentation and other helpful links

Full Blynk Documentation - a complete guide on Blynk features

Community (Forum) - join a 1'000'000 Blynk community to ask questions and share ideas

Official Website

Social Media:

Facebook Twitter Youtube

Instagram LinkedIn

Blynk libraries for other platforms

Contributing

You are very welcome to contribute: stability bugfixes, new hardware support, or any other improvements. Please.

License

This project is released under The MIT License (MIT)