Class Network

Hierarchy

TagoIOModule<ConnectorModuleParams>
- Network

Index

Constructors

Methods

deviceList deviceParamSet info publishToRelay resolveToken

Constructors

constructor

new Network(params: ConnectorModuleParams): Network
Parameters
- params: ConnectorModuleParams
Returns Network
Inherited from TagoIOModule<ConnectorModuleParams>.constructor
- Defined in common/TagoIOModule.ts:75

Methods

deviceList

deviceList(
connectorID: string,
queryObj?: NetworkDeviceListQuery,
): Promise<NetworkDeviceListQueryInfo[]>
Retrieves a list with all devices tokens related to network and connector. Network require_devices_access param need to be true.
Parameters
- connectorID: string
  Connector identification
- OptionalqueryObj: NetworkDeviceListQuery
  Search query params
Returns Promise<NetworkDeviceListQueryInfo[]>
Default
```
queryObj: {
  page: 1,
  filter: {},
  amount: 20,
  orderBy: "name,asc"
}
```
- Defined in modules/Network/Network.ts:95

deviceParamSet

deviceParamSet(
    deviceID: string,
    configObj: Partial<ConfigurationParams>,
    paramID?: string,
): Promise<string>
Create or edit param for the Device in network
Parameters
- deviceID: string
  Device ID
- configObj: Partial<ConfigurationParams>
  Configuration Data
- OptionalparamID: string
  Parameter ID
Returns Promise<string>
- Defined in modules/Network/Network.ts:123

info

info(): Promise<INetworkInfo>
Get information about the current network

Returns Promise<INetworkInfo>
- Defined in modules/Network/Network.ts:11

publishToRelay

publishToRelay(
    options: {
        device: string;
        message?: string;
        qos?: number;
        retain?: boolean;
        topic: string;
    },
): Promise<string>
Publish a message to the MQTT relay
Parameters
- options: {
      device: string;
      message?: string;
      qos?: number;
      retain?: boolean;
      topic: string;
  }
  Options for publishing the message
  - device: string
    The device to publish to (optional)
  - Optionalmessage?: string
    The message to publish (optional)
  - Optionalqos?: number
    Quality of Service level (optional)
  - Optionalretain?: boolean
    Whether to retain the message (optional)
  - topic: string
    The topic to publish to
Returns Promise<string>
A promise that resolves when the message is published
- Defined in modules/Network/Network.ts:55

resolveToken

resolveToken(serieNumber: string, authorization?: string): Promise<string>
Get a valid token using token serie
Parameters
- serieNumber: string
- Optionalauthorization: string
Returns Promise<string>
- Defined in modules/Network/Network.ts:28