Python BLE SDK for Puffco Peak Pro devices
Project description
PuffcoBLE
Python library for communicating with Puffco devices over Bluetooth Low Energy using the Lorax protocol.
This library allows you to connect to a Puffco device, authenticate, read and write Lorax paths, and control device features such as heat cycles, LEDs, lantern mode, and device information. Everything is async and built on top of bleak.
Features
- Scan for devices by name or MAC address
- Automatic Lorax authentication
- Read and write Lorax paths
- Typed reads (int, float, bool) and raw byte reads
- Chunked reads for large data
- Start, stop, and boost heat cycles
- Lantern mode control
- LED brightness control
- Battery, firmware, uptime, and usage info
- Fully async / asyncio-based
Requirements
- Python 3.11+
- Bluetooth Low Energy capable system
Supported platforms:
- Windows
- macOS
- Linux (BlueZ)
Installation
From PyPI:
pip install PuffcoBLE
From source:
git clone https://github.com/Fr0st3h/PuffcoBLE.git
cd PuffcoBLE
pip install -e .
Basic usage
import asyncio
from puffcoble import PuffcoBLE
async def main():
device = PuffcoBLE(device_name="DEV PUFFCO", debug=True)
await device.connect()
print("Device name:", await device.get_device_name())
#get current profile info
currentProfile = await device.get_current_profile_name()
currentProfileTemp = await device.get_current_profile_temp()
currentProfileDuration = await device.get_current_profile_duration()
#start heat cycle
await device.start_heat_cycle()
#sleep for 3 seconds
await asyncio.sleep(3)
#cancel the heat cycle
await device.stop_heat_cycle()
#print the current profiles info
print(f'Current Profile: {currentProfile}, Temperature: {currentProfileTemp}, Duration: {currentProfileDuration} seconds')
payload = {'lamp': {'name': 'solid', 'param': {'color': ["#b700ff"]}}}
#sets profile 4 colour
await device.write_cbor_full("/u/app/hc/3/colr", payload)
await device.disconnect()
asyncio.run(main())
Connection and authentication
Authentication is handled automatically when calling connect():
- BLE bonding trigger
- Access seed request
- Unlock key generation
- Lorax access unlock
Manual authentication is not required for normal usage.
Reading data
Typed read:
temp = await puffco.read(
"/p/app/thc/temp",
size=4,
data_type="float32"
)
Raw bytes:
data = await puffco.read("/p/sys/fw/ver", size=12)
Read full path (chunked):
blob = await puffco.read_bytes_all("/p/app/thc/colr")
Writing data
Write raw bytes:
await puffco.write_short(
"/u/app/ui/lbrt",
0,
0,
bytes([80, 80, 80, 80])
)
Write typed values:
await puffco.write(
"/p/app/thc/time",
45.0,
data_type="float32"
)
Heat cycle control
await puffco.start_heat_cycle()
await puffco.boost_heat_cycle()
await puffco.stop_heat_cycle()
Lantern mode
await puffco.start_lantern()
await puffco.stop_lantern()
Device information
info = await puffco.get_device_info()
serial = await puffco.get_serial_number()
fw = await puffco.get_software_version()
uptime = await puffco.get_uptime()
Debug logging
Enable debug output:
PuffcoBLE(debug=True)
Logging uses Tamga.
Notes
- This project is not affiliated with Puffco
- Firmware updates may break compatibility
- Use at your own risk
License
MIT
Contributing
Pull requests are welcome.
If you add new Lorax paths or opcodes, please document them clearly.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file puffcoble-0.2.0.tar.gz.
File metadata
- Download URL: puffcoble-0.2.0.tar.gz
- Upload date:
- Size: 12.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
30ecbc2554feace1f0ca97bda86ddd9dcd2aaa871bb7a44ca9aa37798dc9f420
|
|
| MD5 |
1b5c81b05e925af0e4cc7093035ca9b2
|
|
| BLAKE2b-256 |
ffe391aba733babdb33b14b07a11234e9910705044d34b4b827c486b8c8412a4
|
Provenance
The following attestation bundles were made for puffcoble-0.2.0.tar.gz:
Publisher:
release.yml on Fr0st3h/PuffcoBLE
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
puffcoble-0.2.0.tar.gz -
Subject digest:
30ecbc2554feace1f0ca97bda86ddd9dcd2aaa871bb7a44ca9aa37798dc9f420 - Sigstore transparency entry: 783798686
- Sigstore integration time:
-
Permalink:
Fr0st3h/PuffcoBLE@9669f9463f30371496fc3975b9f3fdc18458fe84 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/Fr0st3h
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@9669f9463f30371496fc3975b9f3fdc18458fe84 -
Trigger Event:
push
-
Statement type:
File details
Details for the file puffcoble-0.2.0-py3-none-any.whl.
File metadata
- Download URL: puffcoble-0.2.0-py3-none-any.whl
- Upload date:
- Size: 12.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4ee6fd29eba455b9ae2cdb716e58e1c3a617eb88cfad847c9ab078923f9ba4c2
|
|
| MD5 |
1ba4429aade7cd039b3c4c45725876cc
|
|
| BLAKE2b-256 |
28866ff907f14a31c9ba691e15cb500eccd21c8608bf7f5572d2e06849428d4d
|
Provenance
The following attestation bundles were made for puffcoble-0.2.0-py3-none-any.whl:
Publisher:
release.yml on Fr0st3h/PuffcoBLE
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
puffcoble-0.2.0-py3-none-any.whl -
Subject digest:
4ee6fd29eba455b9ae2cdb716e58e1c3a617eb88cfad847c9ab078923f9ba4c2 - Sigstore transparency entry: 783798722
- Sigstore integration time:
-
Permalink:
Fr0st3h/PuffcoBLE@9669f9463f30371496fc3975b9f3fdc18458fe84 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/Fr0st3h
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@9669f9463f30371496fc3975b9f3fdc18458fe84 -
Trigger Event:
push
-
Statement type: