Python SDK

​

Client vs AsyncClient

​

Features

• TLS, mTLS, and certificate validation (including dashboard keys.json)
• E2EE (AES-GCM) enabled by default
• LWT online/offline on connect and disconnect
• Auto request_init() on connect
• Typed events, entity publishing, batch updates, location, offline queue
• Vending mode helpers on Init and Event.DISPENSE for SKU dispense handling
• Payment metadata callbacks (mop / moe / mos) as raw JSON strings
• Optional image upload via firmngin[http]

​

Requirements

• Python 3.9+
• A keys.json file from the Firmngin dashboard

​

Dependencies

​

Quickstart

import asyncio
from firmngin import AsyncClient, ClientConfig, Entity

async def main():
    config = ClientConfig.from_file("keys.json")
    async with AsyncClient(config) as client:
        await client.connect()
        await client.push_entity(Entity("relay"), "on")
        await client.run()

asyncio.run(main())

from firmngin import Client, ClientConfig, Entity

with Client(ClientConfig.from_file("keys.json")) as client:
    client.connect()
    client.push_entity(Entity("relay"), "on")
    client.run()

​

Debug mode

client.set_debug(True)
client.connect()

​

See also

• Installation
• Configuration
• Entities and State
• Events and Callbacks
• Examples
• Arduino