Class NetworkTables

NetworkTables class for interacting with NetworkTables over a WebSocket connection.

Index

Accessors

Methods

addRobotConnectionListener changeURI createPrefixTopic createTopic getPort getURI isRobotConnected isRobotConnecting getInstanceByTeam getInstanceByURI

Accessors

client

get client(): PubSubClient
Gets the PubSubClient instance used to establish and manage the connection to the robot.

Returns PubSubClient
The PubSubClient instance.
- Defined in packages/ntcore-ts-client/src/lib/ntcore-ts-client.ts:35

Methods

addRobotConnectionListener

addRobotConnectionListener(
callback: (_: boolean) => void,
immediateNotify?: boolean,
): () => void
Adds a listener for robot connection status updates.
Parameters
- callback: (_: boolean) => void
  The callback to call when the connection status changes.
- OptionalimmediateNotify: boolean
  Whether to immediately notify the callback of the current connection status.
Returns () => void
A function to remove the listener.
- Defined in packages/ntcore-ts-client/src/lib/ntcore-ts-client.ts:133

changeURI

changeURI(uri: string, port?: number): void
Parameters
- uri: string
- port: number = 5810
Returns void
- Defined in packages/ntcore-ts-client/src/lib/ntcore-ts-client.ts:98

createPrefixTopic

createPrefixTopic(prefix: string): NetworkTablesPrefixTopic
Creates a new topic with a prefix.
Parameters
- prefix: string
  The prefix of the topic.
Returns NetworkTablesPrefixTopic
The topic.
- Defined in packages/ntcore-ts-client/src/lib/ntcore-ts-client.ts:153

createTopic

createTopic<
    T extends
        | string
        | number
        | boolean
        | string[]
        | ArrayBuffer
        | boolean[]
        | number[],
>(
    name: string,
    typeInfo: NetworkTablesTypeInfo,
    defaultValue?: T,
): NetworkTablesTopic<T>
Creates a new topic.
Type Parameters
- T extends string | number | boolean | string[] | ArrayBuffer | boolean[] | number[]
Parameters
- name: string
  The name of the topic.
- typeInfo: NetworkTablesTypeInfo
  The type information of the topic.
- OptionaldefaultValue: T
  The default value of the topic.
Returns NetworkTablesTopic<T>
The topic.
- Defined in packages/ntcore-ts-client/src/lib/ntcore-ts-client.ts:144

getPort

getPort(): number
Returns the port to connect to the robot on.

Returns number
The port number.
- Defined in packages/ntcore-ts-client/src/lib/ntcore-ts-client.ts:107

getURI

getURI(): string
Returns the URI of the server.

Returns string
The robot address.
- Defined in packages/ntcore-ts-client/src/lib/ntcore-ts-client.ts:94

isRobotConnected

isRobotConnected(): boolean
Returns whether the robot is currently connected.

Returns boolean
Whether the robot is connected.
- Defined in packages/ntcore-ts-client/src/lib/ntcore-ts-client.ts:115

isRobotConnecting

isRobotConnecting(): boolean
Returns whether the robot is currently connecting.

Returns boolean
Whether the robot is connecting.
- Defined in packages/ntcore-ts-client/src/lib/ntcore-ts-client.ts:123

`Static`getInstanceByTeam

getInstanceByTeam(team: number, port?: number): NetworkTables
Creates a new NetworkTables instance if it does not exist.
Parameters
- team: number
  The team number of the robot.
- port: number = 5810
  The port to connect to the robot on. Defaults to 5810.
Returns NetworkTables
The NetworkTables instance.

Throws
Error if the team number is not provided.
- Defined in packages/ntcore-ts-client/src/lib/ntcore-ts-client.ts:67

`Static`getInstanceByURI

getInstanceByURI(uri: string, port?: number): NetworkTables
Creates a new NetworkTables instance if it does not exist.
Parameters
- uri: string
  The URI of the robot.
- port: number = 5810
  The port to connect to the robot on. Defaults to 5810.
Returns NetworkTables
The NetworkTables instance.

Throws
Error if the URI is not provided.
- Defined in packages/ntcore-ts-client/src/lib/ntcore-ts-client.ts:82