Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/troublegum/micropyserver
MicroPyServer is a simple HTTP server for MicroPython projects.
https://github.com/troublegum/micropyserver
Last synced: about 1 month ago
JSON representation
MicroPyServer is a simple HTTP server for MicroPython projects.
- Host: GitHub
- URL: https://github.com/troublegum/micropyserver
- Owner: troublegum
- License: mit
- Created: 2019-10-15T05:31:58.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-24T16:10:15.000Z (9 months ago)
- Last Synced: 2024-08-01T10:16:28.889Z (4 months ago)
- Language: Python
- Homepage:
- Size: 38.1 KB
- Stars: 111
- Watchers: 9
- Forks: 29
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-python-web-frameworks - micropyserver - MicroPyServer is a simple HTTP server for MicroPython projects. (Frameworks for Micropython / Dead REST frameworks)
- awesome-micropython - micropyserver - MicroPyServer is a simple HTTP server for MicroPython projects. (Libraries / Communications)
README
# MicroPyServer
[MicroPyServer](https://github.com/troublegum/micropyserver) is a simple HTTP server for MicroPython projects.
**Important!** Version 1.1.x is not compatible with version 1.0.1 and older.
## Install
Download a code and unpack it into your project folder.
Use [Thonny IDE](https://thonny.org/) or other IDE for upload your code in ESP8266/ESP32 board.
## Quick start
### Typical Wi-Fi connection code for ESP board
```
import network
wlan_id = "your wi-fi"
wlan_pass = "your password"
wlan = network.WLAN(network.STA_IF)
wlan.active(True)
while not wlan.isconnected():
wlan.connect(wlan_id, wlan_pass)
print("Connected... IP: " + wlan.ifconfig()[0])
```
### Hello world example
Type in browser http://IP_ADDRESS_ESP/ and you will see "HELLO WORLD" text.
```
from micropyserver import MicroPyServer
''' there should be a wi-fi connection code here '''
def hello_world(request):
''' request handler '''
server.send("HELLO WORLD!")
server = MicroPyServer()
''' add route '''
server.add_route("/", hello_world)
''' start server '''
server.start()
```
### Add some routes
Type in browser http://IP_ADDRESS_ESP/ or http://IP_ADDRESS_ESP/another_action and your will see text "THIS IS INDEX PAGE!" or "THIS IS ANOTHER ACTION!".
```
from micropyserver import MicroPyServer
''' there should be a wi-fi connection code here '''
def show_index(request):
''' main request handler '''
server.send("THIS IS INDEX PAGE!")
def another_action(request):
''' another action handler '''
server.send("THIS IS ANOTHER ACTION!")
server = MicroPyServer()
''' add routes '''
server.add_route("/", show_index)
server.add_route("/another_action", another_action)
''' start server '''
server.start()
```
### Send JSON response example
Type in browser http://IP_ADDRESS_ESP/ and you will see JSON response.
```
from micropyserver import MicroPyServer
import json
''' there should be a wi-fi connection code here '''
def return_json(request):
''' request handler '''
json_str = json.dumps({"param_one": 1, "param_two": 2})
server.send("HTTP/1.0 200 OK\r\n")
server.send("Content-Type: application/json\r\n\r\n")
server.send(json_str)
server = MicroPyServer()
''' add route '''
server.add_route("/", return_json)
''' start server '''
server.start()
```
### Access denied example
Type in browser http://IP_ADDRESS_ESP/ and you will see "THIS IS INDEX PAGE!" text or "ACCESS DENIED!" if your IP not equal "127.0.0.1".
```
from micropyserver import MicroPyServer
''' there should be a wi-fi connection code here '''
def show_index(request):
''' main request handler '''
server.send("THIS IS INDEX PAGE!")
def on_request_handler(request, address):
if str(address[0]) != "127.0.0.1":
server.send("HTTP/1.0 403\r\n\r\n")
server.send("ACCESS DENIED!")
return False
return True
server = MicroPyServer()
''' add route '''
server.add_route("/", show_index)
''' add request handler '''
server.on_request(on_request_handler)
''' start server '''
server.start()
```
### Turn ON / OFF a LED example
You can remote control a LED via internet. Use your browser for on/off LED. Type in browser http://IP_ADDRESS_ESP/on or http://IP_ADDRESS_ESP/off.
```
import esp
import network
import machine
import ubinascii
from micropyserver import MicroPyServer
wlan_id = "your wi-fi"
wlan_pass = "your password"
print("Start...")
mac = ubinascii.hexlify(network.WLAN().config('mac'),':').decode()
print("MAC: " + mac)
wlan = network.WLAN(network.STA_IF)
wlan.active(True)
while not wlan.isconnected():
wlan.connect(wlan_id, wlan_pass)
print("Connected... IP: " + wlan.ifconfig()[0])
def do_on(request):
''' on request handler '''
pin.value(1)
server.send("ON")
def do_off(request):
''' off request handler '''
pin.value(0)
server.send("OFF")
def do_index(request):
''' index request handler '''
server.send("SWITCH ON/OFF")
pin = machine.Pin(13, machine.Pin.OUT)
server = MicroPyServer()
''' add routes '''
server.add_route("/", do_index)
server.add_route("/on", do_on)
server.add_route("/off", do_off)
''' start server '''
server.start()
```
### Use utils for create response
```
from micropyserver import MicroPyServer
import utils
''' there should be a wi-fi connection code here '''
def hello_world(request):
''' request handler '''
utils.send_response(server, "HELLO WORLD!")
def not_found(request):
''' request handler '''
utils.send_response(server, "404", 404)
server = MicroPyServer()
''' add routes '''
server.add_route("/", hello_world)
server.add_route("/404", not_found)
''' start server '''
server.start()
```
### Parse HTTP request. Get query params from request.
Type in browser http://IP_ADDRESS_ESP/?param_one=one¶m_two=two
```
''' Example of HTTP request: GET /?param_one=one¶m_two=two HTTP/1.1\r\nHost: localhost\r\n\r\n '''
from micropyserver import MicroPyServer
import utils
''' there should be a wi-fi connection code here '''
def show_params(request):
''' request handler '''
params = utils.get_request_query_params(request)
print(params)
''' will return {"param_one": "one", "param_two": "two"} '''
server = MicroPyServer()
''' add route '''
server.add_route("/", show_params)
''' start server '''
server.start()
```
## MicroPyServer methods
Constructor - srv = MicroPyServer(host="0.0.0.0", port=80)
Start server - srv.start()
Stop server - srv.stop()
Add new route - srv.add_route(path, handler, method="GET")
Send response to client - srv.send(response)
Return current request - srv.get_request()
Set handler on every request - server.on_request(handler)
Set handler on 404 - server.on_not_found(handler)
Set handler on server error - server.on_error(handler)
## Utils methods
Send response to client - utils.send_response(server, response, http_code=200, content_type="text/html", extend_headers=None)
Return HTTP request method (example of return value: POST) - utils.get_request_method(request)
Return http request query string (example of return value: param_one=one¶m_two=two) - utils.get_request_query_string(request)
Return params from query string (example of return value: {"param_one": "one", "param_two": "two"}) - utils.parse_query_string(query_string)
Return http request query params (example of return value: {"param_one": "one", "param_two": "two"}) - utils.get_request_query_params(request)
Return params from POST request (example of return value: {"param_one": "one", "param_two": "two"}) - utils.get_request_post_params(request)
Unquote string - unquote(string)