Class Fleet

Constructors

constructor

new Fleet(): Fleet
Returns Fleet

Properties

`Static` addDeviceToFleet

addDeviceToFleet: ((deviceId, fleetId) => Promise<any>) = addDeviceToFleet

Type declaration

- (deviceId, fleetId): Promise<any>
- Parameters
  - deviceId: string
  - fleetId: string
  Returns Promise<any>

`Static` aggregateTelemetry

aggregateTelemetry: ((query) => Promise<IStreamAggregateData<keyof IStreamTypeMap>[]>) = aggregateTelemetry

Type declaration

- (query): Promise<IStreamAggregateData<keyof IStreamTypeMap>[]>
- Parameters
  - query: IQuery
  Returns Promise<IStreamAggregateData<keyof IStreamTypeMap>[]>

`Static` createFleet

createFleet: ((fleet) => Promise<IFleet>) = createFleet

Type declaration

- (fleet): Promise<IFleet>
- Parameters
  - fleet: IFleet
  Returns Promise<IFleet>

`Static` createShareLink

createShareLink: ((share, view) => Promise<null | string>) = createShareLink

Type declaration

- (share, view): Promise<null | string>
- Parameters
  - share: IShare
  - view: string
    View name
  Returns Promise<null | string>

`Static` defaultDeviceId

defaultDeviceId: undefined | string

`Static` deleteFleet

deleteFleet: ((id) => Promise<void>) = deleteFleet

Type declaration

- (id): Promise<void>
- Parameters
  - id: string
  Returns Promise<void>

`Static` eventsCounter

eventsCounter: ((eventTypes, timeFrame, range, time, query?) => Promise<{
date: string;
events: IEvent[];
}[]>) = eventsCounter

Type declaration

- (eventTypes, timeFrame, range, time, query?): Promise<{
  date: string;
  events: IEvent[];
  }[]>
- Parameters
  - eventTypes: ("triggered-event" | "datapoint-event" | "device-online" | "device-offline" | "intervention-request" | "teleop-session-record" | "port-forwarding-session-record" | "command-request" | "command-response" | "command-delivery" | "intervention-response" | "custom" | "comment" | "system" | "annotation" | "task-summary" | "stateful")[]
  - timeFrame: AggregateLevel
  - range: number
  - time: number
  - Optional query: IEventQuery
  Returns Promise<{
  date: string;
  events: IEvent[];
  }[]>

`Static` getAllEventTriggerGroup

getAllEventTriggerGroup: (() => Promise<IEventTriggerGroup[]>) = getAllEventTriggerGroup

Type declaration

- (): Promise<IEventTriggerGroup[]>
- Returns Promise<IEventTriggerGroup[]>

`Static` getAnalyticStreams

getAnalyticStreams: (() => Promise<IStreamColumn[]>) = getAnalyticStreams

Type declaration

- (): Promise<IStreamColumn[]>
- retrieves a list of all available data streams that can be used for running analytics. This function takes no arguments and returns a list of stream names that can be used for analyzing data.
  
  Returns Promise<IStreamColumn[]>
  Example
```
// Returns
 [
   {
     streamName:  "$.agent.health",
         streamType :  "health"
       },
{
     streamName:  "up.hours",
         streamType :  "numeric"
       }
]
```

`Static` getAnalyticsModules

getAnalyticsModules: (() => Promise<IAnalyticsModule>) = getAnalyticsModules

Type declaration

- (): Promise<IAnalyticsModule>
- Returns Promise<IAnalyticsModule>

`Static` getAnalyticsRows

getAnalyticsRows: ((query) => Promise<any>) = getAnalyticsRows

Type declaration

- (query): Promise<any>
- Retrieves all rows sqlQuery is required
  Parameters
  - query: ISqlQuery
  Returns Promise<any>

`Static` getAnnotationCount

getAnnotationCount: ((query, tagKey) => Promise<{
[key: string]: number;
}>) = getAnnotationCount

Type declaration

- (query, tagKey): Promise<{
  [key: string]: number;
  }>
- Parameters
  - query: IEventQuery
  - tagKey: string
  Returns Promise<{
  [key: string]: number;
  }>

`Static` getAnnotationCountByIntervals

getAnnotationCountByIntervals: ((query, tagKey, aggregate) => Promise<{
    annotations: {
        [key: string]: number;
    };
    date: string;
}[]>) = getAnnotationCountByIntervals

Type declaration

- (query, tagKey, aggregate): Promise<{
      annotations: {
          [key: string]: number;
      };
      date: string;
  }[]>
- Parameters
  - query: IEventQuery
  - tagKey: string
  - aggregate: AggregateLevel
  Returns Promise<{
      annotations: {
          [key: string]: number;
      };
      date: string;
  }[]>

`Static` getCurrentGroup

getCurrentGroup: (() => Promise<Device[] | undefined>) = getCurrentGroup

Type declaration

- (): Promise<Device[] | undefined>
- Returns Promise<Device[] | undefined>

`Static` getDevices

getDevices: (() => Promise<Device[]>) = getDevices

Type declaration

- (): Promise<Device[]>
- Returns Promise<Device[]>

`Static` getEvent

getEvent: ((uuid) => Promise<IEvent>) = getEvent

Type declaration

- (uuid): Promise<IEvent>
- Parameters
  - uuid: string
  Returns Promise<IEvent>

`Static` getEventTriggerGroup

getEventTriggerGroup: ((id) => Promise<IEventTriggerGroup>) = getEventTriggerGroup

Type declaration

- (id): Promise<IEventTriggerGroup>
- Parameters
  - id: string
  Returns Promise<IEventTriggerGroup>

`Static` getFileUrl

getFileUrl: ((uuid) => Promise<string>) = getFileUrl

Type declaration

- (uuid): Promise<string>
- Parameters
  - uuid: string
  Returns Promise<string>

`Static` getFleet

getFleet: ((id) => Promise<IFleet>) = getFleet

Type declaration

- (id): Promise<IFleet>
- Parameters
  - id: string
  Returns Promise<IFleet>

`Static` getFleetDevices

getFleetDevices: ((id) => Promise<void>) = getFleetDevices

Type declaration

- (id): Promise<void>
- Parameters
  - id: string
  Returns Promise<void>

`Static` getInterventions

getInterventions: (() => Promise<IEvent[]>) = getInterventions

Type declaration

- (): Promise<IEvent[]>
- Returns Promise<IEvent[]>

`Static` getLatestTelemetry

getLatestTelemetry: ((...ids) => Promise<IStreamCurrentValue<keyof IStreamTypeMap>[]>) = getLatestTelemetry

Type declaration

- (...ids): Promise<IStreamCurrentValue<keyof IStreamTypeMap>[]>
- Parameters
  - Rest ...ids: (string | string[])[]
  Returns Promise<IStreamCurrentValue<keyof IStreamTypeMap>[]>

`Static` getOnlineDevices

getOnlineDevices: (() => Promise<Device[]>) = getOnlineDevices

Type declaration

- (): Promise<Device[]>
- Returns Promise<Device[]>

`Static` getPeers

getPeers: (() => Promise<RtcStreamType[]>) = getPeers

Type declaration

- (): Promise<RtcStreamType[]>
- Returns Promise<RtcStreamType[]>

`Static` getRealtimeSessions

getRealtimeSessions: (() => Promise<{
[key in string]: string[]
}>) = getRealtimeSessions

Type declaration

- (): Promise<{
  [key in string]: string[]
  }>
- Returns Promise<{
  [key in string]: string[]
  }>

`Static` getStreams

getStreams: (() => Promise<IStream[]>) = getStreams

Type declaration

- (): Promise<IStream[]>
- Returns Promise<IStream[]>

`Static` getTaskReportRows

getTaskReportRows: ((query) => Promise<any>) = getTaskReportRows

Type declaration

- (query): Promise<any>
- Parameters
  - query: ISqlQuery
  Returns Promise<any>

`Static` getTaskReportTables

getTaskReportTables: (() => Promise<ITaskReportColumn[]>) = getTaskReportTables

Type declaration

(): Promise<ITaskReportColumn[]>

retrieves a list of all available tables that can be used to create task reports. This function takes no arguments and returns a list of table names that can be used for creating task reports.

Returns Promise<ITaskReportColumn[]>

List all available tables

Example

// Returns
[
   {
      name: "",
      tableName: "TASK_REPORTS_CLEANING_MODE",
      columns: [
                {
                   name: "TYPE",
                   isNullable: true,
                   dataType: "string",
                   tableName: "custom"
                }
               ]
   }
]

`Static` getTelemetry

getTelemetry: ((deviceIdOrDeviceIds, streamNameOrStreamNames, start, end, tags?, latestOnly?) => Promise<TelemetryResult[]>) = getTelemetry

Type declaration

- (deviceIdOrDeviceIds, streamNameOrStreamNames, start, end, tags?, latestOnly?): Promise<TelemetryResult[]>
- Parameters
  - deviceIdOrDeviceIds: string | string[]
  - streamNameOrStreamNames: string | string[]
  - start: Date
  - end: Date
  - Optional tags: {}
  - Optional latestOnly: boolean
  Returns Promise<TelemetryResult[]>

`Static` getViews

getViews: (() => Promise<IView[]>) = getViews

Type declaration

- (): Promise<IView[]>
- Returns Promise<IView[]>

`Static` groupDevices

groupDevices: undefined | IDevice[]

`Static` knownContext

knownContext: WeakRef<Device>[] = []

`Static` listFleets

listFleets: (() => Promise<IFleet[]>) = listFleets

Type declaration

- (): Promise<IFleet[]>
- Returns Promise<IFleet[]>

`Static` patchEventTriggergroup

patchEventTriggergroup: ((id, eventTrigger) => Promise<IEventTriggerGroup>) = patchEventTriggerGroup

Type declaration

- (id, eventTrigger): Promise<IEventTriggerGroup>
- Parameters
  - id: string
  - eventTrigger: Partial<IEventTriggerGroup>
  Returns Promise<IEventTriggerGroup>

`Static` patchFleet

patchFleet: ((id, role) => Promise<IFleet>) = patchFleet

Type declaration

- (id, role): Promise<IFleet>
- Parameters
  - id: string
  - role: Partial<IFleet>
  Returns Promise<IFleet>

`Static` patchStream

patchStream: ((stream) => Promise<IStream>) = patchStream

Type declaration

- (stream): Promise<IStream>
- Parameters
  - stream: IStream
  Returns Promise<IStream>

`Static` patchView

patchView: ((view) => Promise<IView>) = patchView

Type declaration

- (view): Promise<IView>
- Parameters
  - view: IView
  Returns Promise<IView>

`Static` queryAnalytics

queryAnalytics: ((query) => Promise<ISqlResult>) = queryAnalytics

Type declaration

(query): Promise<ISqlResult>

Retrieves all stream rows

Parameters

query: ISqlQuery

Returns Promise<ISqlResult>

Example

// Body
const analytics = await queryAnalytics({
    aggregateLevel: "day",
    orderByColumn: "TIMESTAMP",
    streamColumns: [
      {
        streamName: "consumables_residual_percentage",
        streamType: "numeric set",
      },
    ],
  });
//Returns
{
   aggregates: [],
   columns: [
             {
               name: 'TIMESTAMP',
               isNullable: true,
               dataType: 'string',
               tableName: 'NUMERIC_SET_MAIN'
              }
],
   items: [
             {
               axisLabel: "suction_blade",
               name: "consumables_residual_percentage",
               tableName: "NUMERIC_SET_TEST",
               time: "2020-04-20T08:00:00.000Z",
               type: "numeric set",
               unitLabel: "percent"
               }
],
   rowCount: 14,
   rows: []
   sqlText: "SELECT dateadd(day, dayofweek(TIMESTAMP), to_timestamp_tz('4/20/2020')) AS TIMESTAMP, SUM(VALUE)"
}

`Static` queryDevices

queryDevices: ((query) => Promise<Device[]>) = queryDevices

Type declaration

- (query): Promise<Device[]>
- Parameters
  - query: IDeviceQuery
  Returns Promise<Device[]>

`Static` queryEvents

queryEvents: ((query) => Promise<IEvent[]>) = queryEvents

Type declaration

- (query): Promise<IEvent[]>
- Parameters
  - query: IEventQuery
  Returns Promise<IEvent[]>

`Static` queryTelemetry

queryTelemetry: ((query) => Promise<IStreamData<keyof IStreamTypeMap>[]>) = queryTelemetry

Type declaration

- (query): Promise<IStreamData<keyof IStreamTypeMap>[]>
- Parameters
  - query: IQuery
  Returns Promise<IStreamData<keyof IStreamTypeMap>[]>

Methods

`Static` getCurrentDevice

getCurrentDevice(): Promise<Device>
Returns Promise<Device>
- Defined in data-sdk/src/Fleet.ts:64

`Static` getDevice

getDevice(deviceId): Promise<Device>
Parameters
- deviceId: string
Returns Promise<Device>
- Defined in data-sdk/src/Fleet.ts:101

`Static` getGroupDevices

getGroupDevices(): undefined | IDevice[]
Gets the group devices for multi-device contexts. Returns undefined if not in a group context (single device view).

Returns undefined | IDevice[]
Array of device information or undefined
- Defined in data-sdk/src/Fleet.ts:125

`Static` getGroupDevicesAsDeviceInstances

getGroupDevicesAsDeviceInstances(): Promise<Device[]>
Gets all group devices as Device instances. Useful for modules that need full Device objects rather than just IDevice info.

Returns Promise<Device[]>
Promise resolving to array of Device instances
- Defined in data-sdk/src/Fleet.ts:134

`Static` getPeerDevice

getPeerDevice(url): Promise<PeerDevice>
Parameters
- url: string
Returns Promise<PeerDevice>
- Defined in data-sdk/src/Fleet.ts:95

`Static` setDefaultDevice

setDefaultDevice(deviceId): Promise<void>
Parameters
- deviceId: string
Returns Promise<void>
- Defined in data-sdk/src/Fleet.ts:60

`Static` setGroupDevices

setGroupDevices(devices): void
Sets the group devices for multi-device (coherence group) contexts. This is typically called automatically when overview_devices message is received.
Parameters
- devices: IDevice[]
  Array of device information from the host container
Returns void
- Defined in data-sdk/src/Fleet.ts:112

Class Fleet

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Fleet

Properties

Static addDeviceToFleet

Type declaration

Parameters

Returns Promise<any>

Static aggregateTelemetry

Type declaration

Parameters

Returns Promise<IStreamAggregateData<keyof IStreamTypeMap>[]>

Static createFleet

Type declaration

Parameters

Returns Promise<IFleet>

Static createShareLink

Type declaration

Parameters

Returns Promise<null | string>

Static defaultDeviceId

Static deleteFleet

Type declaration

Parameters

Returns Promise<void>

Static eventsCounter

Type declaration

Parameters

Returns Promise<{ date: string; events: IEvent[]; }[]>

Static getAllEventTriggerGroup

Type declaration

Returns Promise<IEventTriggerGroup[]>

Static getAnalyticStreams

Type declaration

Returns Promise<IStreamColumn[]>

Example

Static getAnalyticsModules

Type declaration

Returns Promise<IAnalyticsModule>

Static getAnalyticsRows

Type declaration

Parameters

Returns Promise<any>

Static getAnnotationCount

Type declaration

Parameters

Returns Promise<{ [key: string]: number; }>

Static getAnnotationCountByIntervals

Type declaration

Parameters

Returns Promise<{ annotations: { [key: string]: number; }; date: string; }[]>

Static getCurrentGroup

Type declaration

Returns Promise<Device[] | undefined>

Static getDevices

Type declaration

Returns Promise<Device[]>

Static getEvent

Type declaration

Parameters

Returns Promise<IEvent>

Static getEventTriggerGroup

Type declaration

Parameters

Returns Promise<IEventTriggerGroup>

Static getFileUrl

Type declaration

Parameters

Returns Promise<string>

Static getFleet

Type declaration

Parameters

Returns Promise<IFleet>

Static getFleetDevices

Type declaration

`Static` addDeviceToFleet

`Static` aggregateTelemetry

`Static` createFleet

`Static` createShareLink

`Static` defaultDeviceId

`Static` deleteFleet

`Static` eventsCounter

Returns Promise<{
date: string;
events: IEvent[];
}[]>

`Static` getAllEventTriggerGroup

`Static` getAnalyticStreams

`Static` getAnalyticsModules

`Static` getAnalyticsRows

`Static` getAnnotationCount

Returns Promise<{
[key: string]: number;
}>

`Static` getAnnotationCountByIntervals

Returns Promise<{
annotations: {
[key: string]: number;
};
date: string;
}[]>

`Static` getCurrentGroup

`Static` getDevices

`Static` getEvent

`Static` getEventTriggerGroup

`Static` getFileUrl

`Static` getFleet

`Static` getFleetDevices

`Static` getInterventions

`Static` getLatestTelemetry

`Static` getOnlineDevices

`Static` getPeers

`Static` getRealtimeSessions

Returns Promise<{
[key in string]: string[]
}>

`Static` getStreams

`Static` getTaskReportRows

`Static` getTaskReportTables

`Static` getTelemetry

`Static` getViews

`Static` groupDevices

`Static` knownContext

`Static` listFleets

`Static` patchEventTriggergroup

`Static` patchFleet

`Static` patchStream

`Static` patchView

`Static` queryAnalytics

`Static` queryDevices

`Static` queryEvents