iSCP - RealtimeAPI¶
Provides an API to access endpoints for real-time communication.
Request Methods¶
Warning
Be sure to create the access object using connect_iscp() on client.
client = intdash.Client(...)
conn = await client.connect_iscp()
- class ISCPConn(...)[source]¶
An object that represents a WebSocket connection.
- property is_closed¶
Whether the connection is closed or not.
- Type
bool
- async open_downstream(spec, on_msg=None)[source]¶
Open a downstream with the specified specification.
- Parameters
spec (intdash.DownstreamSpec) – DownstreamSpec
on_msg (func) – Callback to be called when data is received.
- Returns
An object that represents downstream.
- Return type
Downstream
- async open_upstream(spec, marker_interval=1, on_ack=None)[source]¶
Open a upstream with the specified specification.
- Parameters
spec (intdash.UpstreamSpec) – UpstreamSpec
marker_interval (int) – Marker interval in seconds
on_ack (func) – Callback called when a SectionAck is received.
- Returns
An object that represents upstream.
- Return type
Upstream
Request Params¶
- class DownstreamSpec(...)[source]
An object that represents downstream specifications.
- src_edge_uuid
Source edge UUID
- Type
str
- filters
List of data filters
- Type
list[DataFilter]
- dst_edge_uuid
Destination edge UUID
- Type
str
- class DataFilter(...)[source]
An object that represents a data filter.
- data_type
data type
- Type
- channel
Channel number
- Type
int
- data_id
Data ID
- Type
str
- class UpstreamSpec(...)[source]
An object that represents upstream.
- src_edge_uuid
Source edge UUID
- Type
str
- dst_edge_uuids
List of destination edge UUIDs
- Type
list[str]
- resend
Resend flag
- Type
bool
- store
Persistence flag
- Type
bool
- measurement_uuid
bool
- Type
str