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

  • password (str) – Password

  • edge_token (str) – Edge token

  • verify (bool) – Whether to validate the server certificate (default is True)

Note

Either Username/Password or edge Token is required as authentication information.

property captures

Access object to capture resources

Type

intdash.Captures

async connect_iscp(flush_interval=0.01, on_close=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

intdash.ISCPConn

connect_websocket(flush_interval=0.01, auto_reconnect=False)[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

intdash.WebSocketConn

property data_points

Access object to time series data (data point format)

Type

intdash.DataPoints

property edges

Access object to edge resources

Type

intdash.Edges

property measurement_basetimes

Access object to base time resources

Type

intdash.MeasurementBasetimes

property measurement_markers

Access object to measurement marker resources

Type

intdash.MeasurementMarkers

property measurements

Access object to measurement resources

Type

intdash.Measurements

property signals

Access object to signal definition resources

Type

intdash.Signals

property units

Access object to time series data (unit format)

Type

intdash.Units