Configuration - Firmngin AIoT Platform

Quick setup

from firmngin import ClientConfig

config = ClientConfig.from_file("keys.json")

Use this config with AsyncClient (async) or Client (sync).

KeysConfig

from firmngin import KeysConfig

keys = KeysConfig.from_file("keys.json")

Download keys.json from the Firmngin dashboard. The SDK accepts dashboard fields such as server_fingerprint_bytes and sets TLS validation automatically.

Fields

Field	Type	Description
`device_id`	`str`	Device identifier
`device_key`	`str`	Authentication key
`decryptor`	`str`	Hex-encoded AES key for E2EE
`validation_mode`	`str`	`"ca"`, `"pin"`, or `"both"` (optional)
`ca_cert`	`str \| None`	CA certificate PEM
`service_ca_cert`	`str`	Service CA PEM
`client_cert`	`str \| None`	Client cert for mTLS
`private_key`	`str \| None`	Private key for mTLS
`fingerprint_sha256`	`str \| None`	SHA-256 fingerprint
`server_fingerprint_bytes`	`list`	Dashboard fingerprint bytes (optional)

The decryptor_key property holds the parsed key bytes.

ClientConfig

Field	Type	Description
`keys`	`KeysConfig`	Device credentials (required)

Debug mode

Debug is off by default. No banner or console output is printed unless you enable it:

client.set_debug(True)
client.connect()

When enabled, connect() prints lifecycle messages (starting, connected to server) and disconnect() / stop() print stopping and stopped.