How cafanasyev/py-sapient-sdk works
py-sapient-sdk is a Python SDK for SAPIENT sensor and effector interoperability. An application implements the Node contract, configures a dispatcher and TCP client, then registers nodes; the dispatcher manages registration, status reports, and message routing while the transport exchanges typed messages with a fusion node. Major capabilities include lifecycle jitter, connection monitoring and reconnection, and optional TLS/mTLS. The graph follows documented behavior and shown calls; unsampled implementation details are omitted.
Main entry points: dispatcher.py Node dispatcher · node_wrapper.py Node lifecycle · socket_client.py Socket client · client.py Client interface
Components 13
Node lifecycle
- Node contract
src/sapient_sdk/transmission/node.py - Node lifecycle
src/sapient_sdk/transmission/node_wrapper.py - Dispatcher config
src/sapient_sdk/transmission/dispatcher_config.py - Lifecycle jitter
src/sapient_sdk/transmission/jitter.py - Task utilities
src/sapient_sdk/_task_utils.py
Message dispatch
- Node dispatcher
src/sapient_sdk/transmission/dispatcher.py
TCP transport
- Client interface
src/sapient_sdk/transport/client.py - Socket client
src/sapient_sdk/transport/socket_client.py - Connection state
src/sapient_sdk/transport/connection_state.py - Message framing
src/sapient_sdk/transport/framing.py - Socket provider
src/sapient_sdk/transport/socket_provider.py
Other components
- Application
- Fusion node
Connections 21
- Application → Node dispatcher: registers nodes
README.md - Application → Node contract: implements
README.md - Node dispatcher → Node lifecycle: creates
src/sapient_sdk/transmission/dispatcher.py - Node lifecycle → Node contract: polls and calls
src/sapient_sdk/transmission/node_wrapper.py - Node lifecycle → Node dispatcher: publishes lifecycle messages
src/sapient_sdk/transmission/node_wrapper.py - Node lifecycle → Dispatcher config: uses settings
src/sapient_sdk/transmission/node_wrapper.py - Node lifecycle → Lifecycle jitter: gets delays
src/sapient_sdk/transmission/node_wrapper.py - Node dispatcher → Dispatcher config: uses settings
src/sapient_sdk/transmission/dispatcher.py - Node dispatcher → Client interface: starts and publishes
src/sapient_sdk/transmission/dispatcher.py - Node dispatcher → Node contract: routes callbacks
README.md - Node dispatcher → Connection state: monitors connection
src/sapient_sdk/transmission/dispatcher.py - Node dispatcher → Task utilities: cancels tasks
src/sapient_sdk/transmission/dispatcher.py - Node lifecycle → Task utilities: cancels tasks
src/sapient_sdk/transmission/node_wrapper.py - Client interface → Connection state: exposes state
src/sapient_sdk/transport/client.py - Socket client → Client interface: implements
src/sapient_sdk/transport/socket_client.py - Socket client → Socket provider: opens connection
src/sapient_sdk/transport/socket_client.py - Socket client → Message framing: reads and writes frames
src/sapient_sdk/transport/socket_client.py - Socket client → Connection state: updates state
src/sapient_sdk/transport/socket_client.py - Fusion node → Socket client: sends TCP messages
README.md - Socket client → Fusion node: sends TCP messages
README.md - Application → Socket provider: configures TLS optionally
README.md