Class Crazyradio

Hierarchy

EventEmitter
- Crazyradio

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Crazyradio(): Crazyradio

- Defined in drivers/crazyradio.ts:55
Class for controlling the Crazyradio

Returns Crazyradio

Properties

Private consoleLine

consoleLine: string = ""

Private device

device: Device

Private fallbackPingInterval

fallbackPingInterval: Timer

Private fallbackPingTimeout

fallbackPingTimeout: Timer

Private inEndpoint

inEndpoint: InEndpoint

Private inStream

inStream: InStream

Private initialized

initialized: boolean = false

Private interface

interface: Interface

options

options: CrazyradioOptions = defaultOptions

Private outEndpoint

outEndpoint: OutEndpoint

Private outStream

outStream: OutStream

Private packetResponseTimeout

packetResponseTimeout: number = -1

Private pingInterval

pingInterval: number = 5

version

version: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:912
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

close

close(): Promise<Object>

- Defined in drivers/crazyradio.ts:134
Close the dongle

Returns Promise<Object>

configure

configure(options: CrazyradioOptions): Promise<void>

- Defined in drivers/crazyradio.ts:116
Configure new options

Parameters
- options: CrazyradioOptions
Returns Promise<void>

connect

connect(uri: Uri): Promise<Crazyflie>

- Defined in drivers/crazyradio.ts:157
Tune into the correct parameters to connect to a Crazyflie uri and return a Crazyflie instance

Parameters
- uri: Uri
Returns Promise<Crazyflie>

disconnect

disconnect(): void

- Defined in drivers/crazyradio.ts:184
Stop connecting to the drone

Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:923
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:924
Returns Array<string | symbol>

findDrones

findDrones(): Promise<Uri[]>

- Defined in drivers/crazyradio.ts:196
Scan for any nearby Crazyflies

Returns Promise<Uri[]>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:920
Returns number

Private getVendorSetup

getVendorSetup(request: number, value: number, index: number, length: number): Promise<Buffer>

- Defined in drivers/crazyradio.ts:438
Parameters
- request: number
- value: number
- index: number
- length: number
Returns Promise<Buffer>

init

init(options: CrazyradioOptions, device?: Device): Promise<void>

- Defined in drivers/crazyradio.ts:69
For doing all the asynchronous setup of the Crazyradio

Parameters
- options: CrazyradioOptions
- Default value device: Device = Crazyradio.findRadios()[0]
Returns Promise<void>

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:925
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:921
Parameters
- event: string | symbol
Returns Function[]

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:913
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

Private onInStreamData

onInStreamData(data: Buffer): void

- Defined in drivers/crazyradio.ts:257
Parameters
- data: Buffer
Returns void

Private onInStreamError

onInStreamError(err: string): void

- Defined in drivers/crazyradio.ts:319
Parameters
- err: string
Returns void

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:914
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

ping

ping(): Promise<Object>

- Defined in drivers/crazyradio.ts:231
Ping the Crazyflie

Returns Promise<Object>

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:915
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:916
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:922
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:918
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:917
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

scanChannels

scanChannels(start?: number, stop?: number, packet?: Buffer): Promise<Buffer>

- Defined in drivers/crazyradio.ts:411
Parameters
- Default value start: number = 0
- Default value stop: number = 125
- Default value packet: Buffer = BUFFERS.SOMETHING
Returns Promise<Buffer>

scanRange

scanRange(dataRate: number): Promise<Uri[]>

- Defined in drivers/crazyradio.ts:215
Scan for any drones on a specific data rate

Parameters
- dataRate: number
Returns Promise<Uri[]>

sendPacket

sendPacket(packet: Packet): Promise<Object>

- Defined in drivers/crazyradio.ts:242
Communicating with the Crazyflies

Parameters
- packet: Packet
Returns Promise<Object>

Private sendVendorSetup

sendVendorSetup(request: number, value: number, index?: number, data?: Buffer): Promise<void>

- Defined in drivers/crazyradio.ts:416
Parameters
- request: number
- value: number
- Default value index: number = 0
- Default value data: Buffer = BUFFERS.NOTHING
Returns Promise<void>

setAckEnable

setAckEnable(active: boolean): Promise<void>

- Defined in drivers/crazyradio.ts:401
Parameters
- active: boolean
Returns Promise<void>

setAckRetryCount

setAckRetryCount(count: number): Promise<void>

- Defined in drivers/crazyradio.ts:393
Parameters
- count: number
Returns Promise<void>

setAckRetryDelay

setAckRetryDelay(delay: number): Promise<void>

- Defined in drivers/crazyradio.ts:360
Parameters
- delay: number
Returns Promise<void>

setAckRetryDelayBytes

setAckRetryDelayBytes(bytes: number): Promise<void>

- Defined in drivers/crazyradio.ts:389
Parameters
- bytes: number
Returns Promise<void>

setAckRetryDelayMicroseconds

setAckRetryDelayMicroseconds(microseconds: number): Promise<void>

- Defined in drivers/crazyradio.ts:365
Parameters
- microseconds: number
Returns Promise<void>

setContCarrier

setContCarrier(active: boolean): Promise<void>

- Defined in drivers/crazyradio.ts:406
Parameters
- active: boolean
Returns Promise<void>

setDataRate

setDataRate(rate: number): Promise<void>

- Defined in drivers/crazyradio.ts:344
Parameters
- rate: number
Returns Promise<void>

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:919
Parameters
- n: number
Returns this

setRadioAddress

setRadioAddress(address: number): Promise<void>

- Defined in drivers/crazyradio.ts:335
Parameters
- address: number
Returns Promise<void>

setRadioChannel

setRadioChannel(channel: number): Promise<void>

- Defined in drivers/crazyradio.ts:327
Configuration functions

Parameters
- channel: number
Returns Promise<void>

setRadioPower

setRadioPower(power: number): Promise<void>

- Defined in drivers/crazyradio.ts:352
Parameters
- power: number
Returns Promise<void>

Static findRadios

findRadios(vid?: number, pid?: number): Device[]

- Defined in drivers/crazyradio.ts:464
Find available Crazyradios plugged in via USB

Parameters
- Default value vid: number = CRAZYRADIO.VID
- Default value pid: number = CRAZYRADIO.PID
Returns Device[]

Static findUSBDevices

findUSBDevices(): Device[]

- Defined in drivers/crazyradio.ts:480
Find ALL USB devices plugged into the Computer

Returns Device[]

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in /Users/travis/build/michaelgira23/swarms/node_modules/@types/node/index.d.ts:909
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc