Class RawNUTClient

Reserved for advanced uses, use NUTClient

Constructors

constructor

new RawNUTClient(host: string, port?: number): RawNUTClient
Parameters
- host: string
- port: number = 3493
Returns RawNUTClient
- Defined in src/RawNUTClient.ts:54

Accessors

client

get client(): Socket | TLSSocket
Returns Socket | TLSSocket
- Defined in src/RawNUTClient.ts:31

connected

get connected(): boolean
Returns boolean
- Defined in src/RawNUTClient.ts:35
set connected(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/RawNUTClient.ts:39

Methods

connect

connect(username: string, password: string): Promise<void>
Parameters
- username: string
- password: string
Returns Promise<void>
- Defined in src/RawNUTClient.ts:182

getCommandDescription

getCommandDescription(ups: string, command: string): Promise<string>
Parameters
- ups: string
- command: string
Returns Promise<string>
- Defined in src/RawNUTClient.ts:263

getNumLogins

getNumLogins(ups: string): Promise<number>
Parameters
- ups: string
Returns Promise<number>
- Defined in src/RawNUTClient.ts:281

getVariable

getVariable(ups: string, variable: string): Promise<string>
Parameters
- ups: string
- variable: string
Returns Promise<string>
- Defined in src/RawNUTClient.ts:255

getVariableDescription

getVariableDescription(ups: string, variable: string): Promise<string>
Parameters
- ups: string
- variable: string
Returns Promise<string>
- Defined in src/RawNUTClient.ts:241

getVariableEnum

getVariableEnum(ups: string, variable: string): Promise<string[]>
Parameters
- ups: string
- variable: string
Returns Promise<string[]>
- Defined in src/RawNUTClient.ts:245

getVariableRange

getVariableRange(ups: string, variable: string): Promise<string[]>
Parameters
- ups: string
- variable: string
Returns Promise<string[]>
- Defined in src/RawNUTClient.ts:250

getVariableType

getVariableType(ups: string, variable: string): Promise<string>
Parameters
- ups: string
- variable: string
Returns Promise<string>
- Defined in src/RawNUTClient.ts:237

help

help(): Promise<string>
get network protocol version

Returns Promise<string>
- Defined in src/RawNUTClient.ts:216

listClients

listClients(ups: string): Promise<string[]>
Parameters
- ups: string
Returns Promise<string[]>
- Defined in src/RawNUTClient.ts:271

listCommands

listCommands(ups: string): Promise<string[]>
Parameters
- ups: string
Returns Promise<string[]>
- Defined in src/RawNUTClient.ts:232

listUPS

listUPS(): Promise<string[]>
get network protocol version

Returns Promise<string[]>
- Defined in src/RawNUTClient.ts:222

listVariables

listVariables(ups: string): Promise<string[]>
Parameters
- ups: string
Returns Promise<string[]>
- Defined in src/RawNUTClient.ts:227

listWriteableVariables

listWriteableVariables(ups: string): Promise<string[]>
Parameters
- ups: string
Returns Promise<string[]>
- Defined in src/RawNUTClient.ts:276

login(ups: string): Promise<string>
Parameters
- ups: string
  {string} the name of the UPS
Returns Promise<string>
Remarks
You probably shouldn’t send this command unless you are upsmon, or a upsmon replacement.
- Defined in src/RawNUTClient.ts:192

logout

logout(): Promise<string>
Returns Promise<string>
- Defined in src/RawNUTClient.ts:196

netVersion

netVersion(): Promise<string>
get network protocol version

Returns Promise<string>
- Defined in src/RawNUTClient.ts:210

runCommand

runCommand(ups: string, command: string): Promise<string>
Parameters
- ups: string
- command: string
Returns Promise<string>
- Defined in src/RawNUTClient.ts:267

send

send(cmdParts: string[], timeout?: number): Promise<string>
allow to send custom command
Parameters
- cmdParts: string[]
- Optionaltimeout: number
Returns Promise<string>
- Defined in src/RawNUTClient.ts:173

setVariable

setVariable(ups: string, variable: string, value: unknown): Promise<string>
Parameters
- ups: string
- variable: string
- value: unknown
Returns Promise<string>
- Defined in src/RawNUTClient.ts:259

startTLS

startTLS(
tlsOptions?: Omit<ConnectionOptions, "socket" | "host" | "port">,
): Promise<void>
Parameters
- OptionaltlsOptions: Omit<ConnectionOptions, "socket" | "host" | "port">
Returns Promise<void>
- Defined in src/RawNUTClient.ts:113

version

version(): Promise<string>
get server version

Returns Promise<string>
- Defined in src/RawNUTClient.ts:203