Skip to content

index.md

Latest commit

 

History

History
115 lines (76 loc) · 2.73 KB

index.md

File metadata and controls

115 lines (76 loc) · 2.73 KB
Raw

API Reference

This section provides detailed documentation for all public classes and functions in unetpy.

Note: This documentation is auto-generated from source code docstrings. To regenerate, run: python docs/generate_api_docs.py

Core Classes

UnetSocket

The main high-level interface for communicating with UnetStack nodes. Provides a socket-like API for sending and receiving datagrams.

from unetpy import UnetSocket

with UnetSocket("localhost", 1100) as sock:
    sock.bind(Protocol.USER)
    sock.send([1, 2, 3], to=31, protocol=Protocol.USER)

Constants

Protocol

Protocol number assignments for different types of communication.

from unetpy import Protocol

Protocol.DATA  # User application data (0)
Protocol.USER  # User protocols start here (32)
Protocol.MAX   # Maximum protocol number (63)

Services

Service identifiers for looking up agents.

from unetpy import Services

Services.PHYSICAL        # Physical layer service
Services.DATAGRAM        # Datagram service
Services.NODE_INFO       # Node information service

Address

Address constants.

from unetpy import Address

Address.BROADCAST  # Broadcast address (0)

Messages

Message Classes

All UnetStack message classes can be imported directly.

from unetpy import DatagramReq, DatagramNtf

req = DatagramReq()
req.to = 31
req.data = [1, 2, 3]

Common Messages

  • DatagramReq - Request to send a datagram
  • DatagramNtf - Notification of received datagram
  • RxFrameNtf - Physical layer frame received
  • TxFrameReq - Request to transmit a frame

Utilities

to_gps

Convert local coordinates to GPS coordinates.

from unetpy import to_gps

lat, lon = to_gps(origin=(1.34, 103.84), x=100, y=100)

to_local

Convert GPS coordinates to local coordinates.

from unetpy import to_local

x, y = to_local(origin=(1.34, 103.84), lat=1.35, lon=103.85)

Re-exported from fjagepy

The following classes are re-exported from fjagepy for convenience:

  • Gateway - Low-level connection to fjåge container
  • AgentID - Reference to an agent
  • Message - Base message class
  • MessageClass - Factory for creating message types
  • Performative - Message performatives (AGREE, REFUSE, etc.)
  • ParameterReq - Request for a parameter value
  • ParameterRsp - Response with a parameter value
  • PutFileReq - Request to upload a file
  • GetFileReq - Request to download a file
  • ShellExecReq - Request to execute a shell command
  • GetFileRsp - Response with file contents