https://github.com/alanedwardes/ae.pico

https://github.com/alanedwardes/ae.pico

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/alanedwardes/ae.pico
• Owner: alanedwardes
• Created: 2023-11-10T20:43:33.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-08T17:32:25.000Z (6 days ago)
• Last Synced: 2024-11-08T17:44:30.564Z (6 days ago)
• Language: Python
• Size: 166 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ae.Pico

A collection of Micropython libraries for the Raspberry Pi Pico W.

## [ws.py](./libraries/ws.py)

Provides async WebSocket connection with SSL support.

### Installation

```python

import mip

mip.install('github:alanedwardes/Ae.Pico/libraries/ws.py')

```

### Basic Usage

```python

import ws

socket = await ws.connect('wss://endpoint')

while True:

    message = await socket.recv()        

    if message is None:

        # Do nothing - this was a ping/pong response

        continue

    # Do something with message

    payload = json.loads(message)

    # Send something back

    await socket.send('{"test":true}')

```

## [hassws.py](./libraries/hassws.py)

Home Assistant [WebSocket API](https://developers.home-assistant.io/docs/api/websocket/) support. Depends on [ws.py](#wspy).

### Installation

```python

import mip

mip.install('github:alanedwardes/Ae.Pico/libraries/ws.py')

mip.install('github:alanedwardes/Ae.Pico/libraries/hassws.py')

```

### Basic Usage

```python

from hassws import HassWs

import network

nic = network.WLAN(network.STA_IF)

# HassWs polls the nic until there is a

# connection, before attempting to connect

hass = HassWs('ws://homeassistant', '', nic)

def example_sensor_updated(entity_id, entity):

    if entity['s'] == 'on':

        # Do something if sensor is 'on'

# Subscribe to entity to get updates

hass.subscribe('sensor.example', example_sensor_updated)

while True:

    try:

        await hass.start()

    except:

        # Do something with exception

    finally:

        await hass.stop()

# Call an action

await hass.action('climate', 'set_temperature', {'temperature': 19}, 'climate.kitchen')

```

## [hass.py](./libraries/hass.py)

Home Assistant [REST API](https://developers.home-assistant.io/docs/api/rest/) support.

### Installation

```python

import mip

mip.install('github:alanedwardes/Ae.Pico/libraries/hass.py')

```

### Basic Usage

```python

from hass import Hass

# Init Home Assistant

hass = Hass('http://homeassistant', '')

# Send sensor update

await hass.send_update(17, '°C"', 'temperature', 'Sensor Name', 'sensor.my_sensor_id')

# Render template

time = await hass.render_template('{{ now() }}')

# Set the RTC from Home Assistant's clock

await hass.set_time()

```

## [management.py](./libraries/management.py)

Simple HTTP management server with support for editing/uploading/downloading files, and rebooting.

### Installation

```python

import mip

mip.install('github:alanedwardes/Ae.Pico/libraries/management.py')

```

### Basic Usage

```python

import management

# Listen on port 80

server = management.ManagementServer(80)

# Optionally require HTTP basic auth

server.set_credentials('username', 'password')

while True:

    try:

        await server.start()

    except:

        # Do something with exception

    finally:

        await server.stop()

```

## [remotetime.py](./libraries/remotetime.py)

Support for NTP and HTTP(S) time sources to configure the RTC. HTTP(S) endpoints must return a tuple in the same format as the [MicroPython RTC](https://docs.micropython.org/en/latest/library/machine.RTC.html):

```

(year, month, day, weekday, hours, minutes, seconds, subseconds)

```

The Raspberry Pi Pico W doesn't support `subseconds`, so that can be zero. Unless specifically required `weekday` can also be zero.

### Basic Usage

```python

from remotetime import RemoteTime

import network

nic = network.WLAN(network.STA_IF)

# RemoteTime polls the nic until there is a

# connection, before attempting to connect

# RemoteTime(endpoint, update_time_ms, nic)

rt = RemoteTime('ntp://pool.ntp.org', 300_000, nic)

while True:

    try:

        await rt.start()

    except:

        # Do something with exception

    finally:

        await rt.stop()

```

## [wifi.py](./libraries/wifi.py)

Connects to WiFi, and attempts to re-establish the connection if it drops.

### Basic Usage

```python

from wifi import WiFi

import network

nic = network.WLAN(network.STA_IF)

wifi = WiFi('hostname', 'ssid', 'secret', nic)

while True:

    try:

        await wifi.start()

    except:

        # Do something with exception

    finally:

        await wifi.stop()

```