ClientSessionReadHistoryService | NodeOPCUA reference documentation

Hierarchy

ClientSessionReadHistoryService
- ClientSession

Index

Methods

historyRead

historyRead(request: HistoryReadRequest, callback: Callback<HistoryReadResponse>): void
historyRead(request: HistoryReadRequest): Promise<HistoryReadResponse>

- Defined in node-opcua-client/dist/client_session.d.ts:340
Parameters
- request: HistoryReadRequest
- callback: Callback<HistoryReadResponse>
Returns void
- Defined in node-opcua-client/dist/client_session.d.ts:341
Parameters
- request: HistoryReadRequest
Returns Promise<HistoryReadResponse>

readAggregateValue

readAggregateValue(nodesToRead: HistoryReadValueIdOptions[], startTime: DateTime, endTime: DateTime, aggregateFn: AggregateFunction[], processingInterval: number, callback: Callback<HistoryReadResult[]>): void
readAggregateValue(nodesToRead: HistoryReadValueIdOptions[], startTime: DateTime, endTime: DateTime, aggregateFn: AggregateFunction[], processingInterval: number): Promise<HistoryReadResult[]>
readAggregateValue(nodeToRead: HistoryReadValueIdOptions, startTime: DateTime, endTime: DateTime, aggregateFn: AggregateFunction, processingInterval: number, callback: Callback<HistoryReadResult>): void
readAggregateValue(nodeToRead: HistoryReadValueIdOptions, startTime: DateTime, endTime: DateTime, aggregateFn: AggregateFunction, processingInterval: number): Promise<HistoryReadResult>

method

readAggregateValue

async

example

//  es5
session.readAggregateValue(
  {nodeId: "ns=5;s=Simulation Examples.Functions.Sine1" },
  new Date("2015-06-10T09:00:00.000Z"),
  new Date("2015-06-10T09:01:00.000Z"),
 AggregateFunction.Average, 3600000, (err,dataValues)  => {

});

//  es6
const dataValues = await session.readAggregateValue(
  { nodeId: "ns=5;s=Simulation Examples.Functions.Sine1" },
  new Date("2015-06-10T09:00:00.000Z"),
  new Date("2015-06-10T09:01:00.000Z"),
  AggregateFunction.Average, 3600000);

Parameters

nodesToRead: HistoryReadValueIdOptions[]
startTime: DateTime

the start time in UTC format
endTime: DateTime

the end time in UTC format
aggregateFn: AggregateFunction[]
processingInterval: number

in milliseconds
callback: Callback<HistoryReadResult[]>

Returns void

- Defined in node-opcua-client/dist/client_session.d.ts:337
Parameters
- nodesToRead: HistoryReadValueIdOptions[]
- startTime: DateTime
- endTime: DateTime
- aggregateFn: AggregateFunction[]
- processingInterval: number
Returns Promise<HistoryReadResult[]>
- Defined in node-opcua-client/dist/client_session.d.ts:338
Parameters
- nodeToRead: HistoryReadValueIdOptions
- startTime: DateTime
- endTime: DateTime
- aggregateFn: AggregateFunction
- processingInterval: number
- callback: Callback<HistoryReadResult>
Returns void
- Defined in node-opcua-client/dist/client_session.d.ts:339
Parameters
- nodeToRead: HistoryReadValueIdOptions
- startTime: DateTime
- endTime: DateTime
- aggregateFn: AggregateFunction
- processingInterval: number
Returns Promise<HistoryReadResult>

readHistoryValue

readHistoryValue(nodesToRead: NodeIdLike[] | HistoryReadValueIdOptions2[], start: DateTime, end: DateTime, callback: (err: Error, results?: HistoryReadResult[]) => void): void
readHistoryValue(nodesToRead: NodeIdLike[] | HistoryReadValueIdOptions2[], start: DateTime, end: DateTime, options: ExtraReadHistoryValueParameters, callback: (err: Error, results?: HistoryReadResult[]) => void): void
readHistoryValue(nodesToRead: NodeIdLike[] | HistoryReadValueIdOptions2[], start: DateTime, end: DateTime, options?: ExtraReadHistoryValueParameters): Promise<HistoryReadResult[]>
readHistoryValue(nodeToRead: NodeIdLike | HistoryReadValueIdOptions2, start: DateTime, end: DateTime, callback: (err: Error, result?: HistoryReadResult) => void): void
readHistoryValue(nodeToRead: NodeIdLike | HistoryReadValueIdOptions2, start: DateTime, end: DateTime, options: ExtraReadHistoryValueParameters, callback: (err: Error, result?: HistoryReadResult) => void): void
readHistoryValue(nodeToRead: NodeIdLike | HistoryReadValueIdOptions2, start: DateTime, end: DateTime, options?: ExtraReadHistoryValueParameters): Promise<HistoryReadResult>

- Defined in node-opcua-client/dist/client_session.d.ts:298
Parameters
- nodesToRead: NodeIdLike[] | HistoryReadValueIdOptions2[]
- start: DateTime
- end: DateTime
- callback: (err: Error, results?: HistoryReadResult[]) => void
  - - (err: Error, results?: HistoryReadResult[]): void
    - Parameters
      - err: Error
      - Optional results: HistoryReadResult[]
      Returns void
Returns void
- Defined in node-opcua-client/dist/client_session.d.ts:299
Parameters
- nodesToRead: NodeIdLike[] | HistoryReadValueIdOptions2[]
- start: DateTime
- end: DateTime
- options: ExtraReadHistoryValueParameters
- callback: (err: Error, results?: HistoryReadResult[]) => void
  - - (err: Error, results?: HistoryReadResult[]): void
    - Parameters
      - err: Error
      - Optional results: HistoryReadResult[]
      Returns void
Returns void
- Defined in node-opcua-client/dist/client_session.d.ts:300
Parameters
- nodesToRead: NodeIdLike[] | HistoryReadValueIdOptions2[]
- start: DateTime
- end: DateTime
- Optional options: ExtraReadHistoryValueParameters
Returns Promise<HistoryReadResult[]>
- Defined in node-opcua-client/dist/client_session.d.ts:301
Parameters
- nodeToRead: NodeIdLike | HistoryReadValueIdOptions2
- start: DateTime
- end: DateTime
- callback: (err: Error, result?: HistoryReadResult) => void
  - - (err: Error, result?: HistoryReadResult): void
    - Parameters
      - err: Error
      - Optional result: HistoryReadResult
      Returns void
Returns void
- Defined in node-opcua-client/dist/client_session.d.ts:302
Parameters
- nodeToRead: NodeIdLike | HistoryReadValueIdOptions2
- start: DateTime
- end: DateTime
- options: ExtraReadHistoryValueParameters
- callback: (err: Error, result?: HistoryReadResult) => void
  - - (err: Error, result?: HistoryReadResult): void
    - Parameters
      - err: Error
      - Optional result: HistoryReadResult
      Returns void
Returns void
- Defined in node-opcua-client/dist/client_session.d.ts:303
Parameters
- nodeToRead: NodeIdLike | HistoryReadValueIdOptions2
- start: DateTime
- end: DateTime
- Optional options: ExtraReadHistoryValueParameters
Returns Promise<HistoryReadResult>

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Methods

Methods

historyRead

Parameters

request: HistoryReadRequest

callback: Callback<HistoryReadResponse>

Returns void

Parameters

request: HistoryReadRequest

Returns Promise<HistoryReadResponse>

readAggregateValue

Parameters

nodesToRead: HistoryReadValueIdOptions[]

startTime: DateTime

endTime: DateTime

aggregateFn: AggregateFunction[]

processingInterval: number

callback: Callback<HistoryReadResult[]>

Returns void

Parameters

nodesToRead: HistoryReadValueIdOptions[]

startTime: DateTime

endTime: DateTime

aggregateFn: AggregateFunction[]

processingInterval: number

Returns Promise<HistoryReadResult[]>

Parameters

nodeToRead: HistoryReadValueIdOptions

startTime: DateTime

endTime: DateTime

aggregateFn: AggregateFunction

processingInterval: number

callback: Callback<HistoryReadResult>

Returns void

Parameters

nodeToRead: HistoryReadValueIdOptions

startTime: DateTime

endTime: DateTime

aggregateFn: AggregateFunction

processingInterval: number

Returns Promise<HistoryReadResult>

readHistoryValue

Parameters

nodesToRead: NodeIdLike[] | HistoryReadValueIdOptions2[]

start: DateTime

end: DateTime

callback: (err: Error, results?: HistoryReadResult[]) => void

Parameters

err: Error

Optional results: HistoryReadResult[]

Returns void

Returns void

Parameters

nodesToRead: NodeIdLike[] | HistoryReadValueIdOptions2[]

start: DateTime

end: DateTime

options: ExtraReadHistoryValueParameters

callback: (err: Error, results?: HistoryReadResult[]) => void

Parameters

err: Error

Optional results: HistoryReadResult[]

Returns void

Returns void

Parameters

nodesToRead: NodeIdLike[] | HistoryReadValueIdOptions2[]

start: DateTime

end: DateTime

Optional options: ExtraReadHistoryValueParameters

Returns Promise<HistoryReadResult[]>

Parameters

nodeToRead: NodeIdLike | HistoryReadValueIdOptions2

start: DateTime

end: DateTime

callback: (err: Error, result?: HistoryReadResult) => void

Parameters

err: Error

Optional result: HistoryReadResult