intdash client¶
An access client to the intdash REST server.
- class Client(...)[source]¶
An access client to the intdash REST server.
- Parameters
url (str) – intdash REST API server URL
username (str) –
Username
Deprecated since version 2.1.0.
password (str) –
Password
Deprecated since version 2.1.0.
edge_token (str) – Edge token
verify (bool) – Whether to validate the server certificate (default is
True
)session (requests.Session) – Session
Note
Either edge Token or
requests-oauthlib.Session
is required as authentication information.**Username/Password** were deprecated.- property captures¶
Access object to capture resources
- Type
- async connect_iscp(flush_interval=0.01, on_close=None, token_source: Optional[TokenSource] = None)[source]¶
Connect to an endpoint for real-time communication.
- Parameters
flush_interval (float) – Flush interval in seconds
on_close (func) – Callback function to be called on close
- Returns
ISCPConnection
- Return type
- connect_websocket(flush_interval=0.01, auto_reconnect=False, token_source: Optional[TokenSource] = None)[source]¶
Connect to an endpoint for real-time communication.
- Parameters
flush_interval (float) – Flush interval in seconds
auto_reconnect (bool) – Auto reconnect flag
- Returns
WebSocket connection
- Return type
- property data_points¶
Access object to time series data (data point format)
- Type
- property edges¶
Access object to edge resources
- Type
- property measurement_basetimes¶
Access object to base time resources
- property measurement_markers¶
Access object to measurement marker resources
- property measurements¶
Access object to measurement resources
- Type
- property signals¶
Access object to signal definition resources
- Type
- property units¶
Access object to time series data (unit format)
- Type