Class AutoRos

Auto reconnecting wrapper of ROSLIB.Ros

This class extends EventEmitter and provides automatic reconnection functionality for ROS connections through rosbridge.

Example

import AutoRos from 'auto-ros'

const autoRos = new AutoRos()
autoRos.connect('ws://localhost:9090')

autoRos.on('status', (status) => {
  console.log('Connection status:', status)
})

Hierarchy

EventEmitter
- AutoRos

Index

Constructors

constructor

new AutoRos(options?: AutoRosOptions): AutoRos
Create a new AutoRos instance
Parameters
- Optionaloptions: AutoRosOptions
  Configuration options
Returns AutoRos
Throws
If 'url' is provided in rosOptions (use connect method instead)
Overrides EventEmitter.constructor
- Defined in src/index.ts:86

Properties

ros

ros: Ros

The underlying Ros instance

`Static`prefixed

prefixed: string | boolean

Accessors

status

get status(): ConnectionStatus
Get the current connection status

Returns ConnectionStatus
- Defined in src/index.ts:110
set status(value: ConnectionStatus): void
Set the connection status and emit status event
Parameters
- value: ConnectionStatus
  New status value
Returns void
- Defined in src/index.ts:119

Methods

addListener

addListener<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

connect

connect(url?: string): void
Connect to rosbridge

If a URL is provided, it will connect to that one. Otherwise, it will use the previous URL. Uses a URL based on the hostname if no URLs have been provided.
Parameters
- Optionalurl: string
  WebSocket URL to connect to (e.g., 'ws://localhost:9090')
Returns void
- Defined in src/index.ts:133

emit

emit<T extends string | symbol>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends string | symbol>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: string | symbol): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

Class AutoRos

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AutoRos

Throws

Properties

ros

Staticprefixed

Accessors

status

Returns ConnectionStatus

Parameters

Returns void

Methods

addListener

Type Parameters

Parameters

Returns this

connect

Parameters

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ((...args: any[]) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

Settings

On This Page

`Static`prefixed