Python reference#
Every pamoja module, generated by pdoc from this commit. Each row below opens a module's API pages, and the same capability in the other three languages is one step away.
Each capability is its own distribution and one module of the pamoja
namespace, so an import names the capability it uses, and the page for each
module lists its classes and functions with their signatures. pamoja installs
all of them.
Each module is hand-written Python over pamoja-native, the compiled engine,
whose type stub ships as pamoja/_native/__init__.pyi so an editor sees every
native signature; pamoja.raw re-exports that contract for anything the
facades do not cover.
By domain#
Six of the chapters hold more than one capability, and each is a package of its
own on PyPI, pamoja-<domain>, which brings its capabilities in and re-exports
each under its own name:
pip install pamoja-field-iopip install pamoja-sensingpip install pamoja-radiopip install pamoja-trustpamoja.transportsMQTT, CoAP, Loopback, Store and forward, Transport ladder, Event bus, Engine surface, Simulators
pip install pamoja-transportspip install pamoja-profilesEvery package#
One row per capability: the install line, the module and its reference, the guide with the worked example, and the same capability on the other three reference pages, one step away.
Engine#
pamoja.coreThe transport every link shares (send, receive, subscribe, and a faulty wrapper for tests) and the runtime version
pip install pamoja-coreIdentity#
pamoja.securityed25519 device identity: sign a reading and verify it, so a gateway can prove it is authentic
pip install pamoja-securityCodecs#
pamoja.codecCBOR, JSON, and raw codecs behind one trait, delta and varint batch packing, and an f32 quantizer for metered links
pip install pamoja-codecHelpers#
pamoja.kitPlain-language helper math: smoothing, calibration, PID and thermostat control, trend and surge prediction, rolling windows, kinematics, and geo
pip install pamoja-kitField I/O#
pamoja.serialSLIP and COBS byte stuffing with streaming decoders, so a UART byte stream carries discrete packets
pip install pamoja-serialpip install pamoja-modbuspamoja.canCAN 2.0 and CAN-FD frames with 11- and 29-bit identifiers, plus J1939 decode and compose
pip install pamoja-canpamoja.gpioI2C address frames with reserved-range checks, the four SPI clock modes, and active-high or active-low pins
pip install pamoja-gpioSensing and actuation#
pamoja.sensorsDatasheet-anchored decoders for eleven parts: the BME280, BMP280, DS18B20, HDC1080, INA219, INA226, ADS1115, OPT3001, SCD4x, SHT3x, and TMP117
pip install pamoja-sensorspip install pamoja-actuatorsRadio and reach#
pamoja.loraTime-on-air, duty-cycle off-time, and the regional channel plans a LoRa node must keep to
pip install pamoja-lorapamoja.lorawanLoRaWAN 1.0.x MAC framing, AES-CMAC and AES encryption, and both halves of the OTAA join
pip install pamoja-lorawanpamoja.meshAddressed, hop-limited, CRC-checked frames and duplicate suppression that floods a packet exactly once
pip install pamoja-meshpip install pamoja-routingMAVLink#
pamoja.mavlinkMAVLink v1 and v2 framing, signing, named message fields, and the mission, command, and offboard protocols
pip install pamoja-mavlinkTrust and operation#
pamoja.auditA tamper-evident, hash-chained log; altering, reordering, or dropping a record breaks verification
pip install pamoja-auditpamoja.sessionX25519 key agreement, HKDF, and ChaCha20-Poly1305 with an anti-replay window, with no TLS stack
pip install pamoja-sessionpamoja.updateSigned firmware manifests, streaming image verification, and A/B slots that fall back on their own
pip install pamoja-updatepamoja.powerDuty cycling and an energy-aware governor that stretches work as the battery drains
pip install pamoja-powerpamoja.telemetryObservability that ships only what is worth the bytes as link cost rises, while counting everything
pip install pamoja-telemetryTransports and testing#
pip install pamoja-mqttpip install pamoja-coappamoja.loopbackAn in-process transport with topic matching and a fault injector, for testing with no broker
pip install pamoja-loopbackpamoja.syncOffline-first queues: in memory, and a crash-safe on-disk queue that survives power loss
pip install pamoja-syncpamoja.ladderCheapest reachable link first, buffering to a store when every link is down
pip install pamoja-ladderpip install pamoja-buspamoja.simNoisy and replay sensors, a recording actuator, and a simulated robot that dead-reckons its pose
pip install pamoja-simProfiles and robotics#
pip install pamoja-profilepamoja.ros2ROS 2 names, RIHS01 type hashes, CDR encoding, and rmw_zenoh key assembly, with no ROS 2 installed
pip install pamoja-ros2pip install pamoja-zenoh