radiod-ts

Index

Type aliases

CmdWifiWhiteListParam

Functions

Type aliases

CmdWifiWhiteListParam

CmdWifiWhiteListParam: string[]

List of BSSIDs in form "XX:XX:XX:XX:XX:XX".

Functions

NatsCmdSubject

NatsCmdSubject(name: string, platform?: Platform): string

- Defined in api.ts:125
Generates the NATS subject for:
PLATFORM.NAME.radiod.cmd

Send a state command to the vehicle NAME
- Param CmdMessage
- Returns Result
Parameters
- name: string
  
  Vehicle name
- platform: Platform = Platform.ACU
Returns string
NATS subject

NatsConfigGetSubject

NatsConfigGetSubject(name: string): string

- Defined in radiodconfig.ts:55
Generates the nats subject for:
acu.NAME.radiod.config

Request the current configuration for the vehicle NAME
- Returns RadiodConfig
Parameters
- name: string
  
  Vehicle name
Returns string
Nats subject

NatsConfigSetDefaultSubject

NatsConfigSetDefaultSubject(name: string): string

- Defined in radiodconfig.ts:84
Generates the nats subject for:
acu.NAME.radiod.config.set.default

Reset the configuration to the default value for the vehicle NAME
- Returns Result
Parameters
- name: string
  
  Vehicle name
Returns string
Nats subject

NatsConfigSetSubject

NatsConfigSetSubject(name: string): string

- Defined in radiodconfig.ts:70
Generates the nats subject for:
acu.NAME.radiod.config.set

Set a new configuration for the vehicle NAME
- Param RadiodConfig
- Returns Result
Parameters
- name: string
  
  Vehicle name
Returns string
Nats subject

NatsGetSubject

NatsGetSubject(name: string, platform?: Platform): string

- Defined in api.ts:312
Generates the NATS subject for:
PLATFORM.NAME.radiod.get

Get some piece of information from Radiod Use request-reply type of message
- Param GetMessage
- Returns Result or GetReplyNetworkStatus
Parameters
- name: string
  
  Vehicle name
- platform: Platform = Platform.ACU
Returns string
NATS subject

NatsHeartbeatSubject

NatsHeartbeatSubject(name: string): string

- Defined in heartbeat.ts:19
Generates the nats subject for:
acu.NAME.radiod.heartbeat

Listen to heartbeat messages
- Yields Heartbeat
Expected to yield 1 heartbeat message / second
Parameters
- name: string
  
  Vehicle name
Returns string
Nats subject

NatsKeyAddSubject

NatsKeyAddSubject(name: string, platform?: Platform): string

- Defined in keyapi.ts:28
Generates the nats subject for:
PLATFORM.NAME.radiod.key.add

Add private or public key to vehicle Name
- Param Key
- Returns Result
Parameters
- name: string
  
  Vehicle name
- platform: Platform = Platform.ACU
Returns string
Nats subject

NatsKeyListSubject

NatsKeyListSubject(name: string, platform?: Platform): string

- Defined in keyapi.ts:77
Generates the nats subject for:
PLATFORM.NAME.radiod.key.list

List all keys saved for Radiod.
- Param Key
- Returns KeyList
Parameters
- name: string
  
  Vehicle name
- platform: Platform = Platform.ACU
Returns string
Nats subject

NatsKeyRemoveSubject

NatsKeyRemoveSubject(name: string, platform?: Platform): string

- Defined in keyapi.ts:43
Generates the nats subject for:
PLATFORM.NAME.radiod.key.remove

Remove private or public key from vehicle Name
- Param Key
- Returns Result
Parameters
- name: string
  
  Vehicle name
- platform: Platform = Platform.ACU
Returns string
Nats subject

NatsMetricSubject

NatsMetricSubject(name: string, topic: MetricTopic, metric: string, platform?: Platform): string

- Defined in metric.ts:701
Generates the nats subject for:
PLATFORM.NAME.radiod.log.metric.TOPIC.METRIC

Yields the value of TOPIC.METRIC
- Returns Metric
Parameters
- name: string
  
  Vehicle name
- topic: MetricTopic
- metric: string
- platform: Platform = Platform.ACU
Returns string
Nats subject

NatsPartSubject

NatsPartSubject(name: string, platform?: Platform): string

- Defined in part.ts:28
Generates the nats subject for:
PLATFORM.NAME.radiod.part

Get Radiod part info. Make an empty request to this endpoint to get the response.
- Returns PartInfo
Parameters
- name: string
  
  Vehicle name
- platform: Platform = Platform.ACU
Returns string
Nats subject

Generated using TypeDoc