Class TOCFetcher

Hierarchy

EventEmitter
- TOCFetcher

Index

Constructors

constructor

Properties

Accessors

cachePath

Constructors

constructor

new TOCFetcher(crazyflie: Crazyflie, type: TOC_TYPES): TOCFetcher

- Defined in crazyflie/toc-fetcher.ts:41
Fetches TOC from the Crazyflie. Specify port because both parameters and logging use the same system (https://wiki.bitcraze.io/doc:crazyflie:crtp:log#table_of_content_access) (https://wiki.bitcraze.io/doc:crazyflie:crtp:param#toc_access)

Parameters
- crazyflie: Crazyflie
- type: TOC_TYPES
Returns TOCFetcher

Properties

Private crazyflie

crazyflie: Crazyflie

crc

crc: number

fetched

fetched: boolean = false

length

length: number

maxOperations

maxOperations: number

maxPackets

maxPackets: number

port

port: number

toc

toc: TOC = new TOC()

type

type: TOC_TYPES

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

cachePath

get cachePath(): string

- Defined in crazyflie/toc-fetcher.ts:17
Returns string

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

cacheTOC

cacheTOC(crc: number, items: TOCItem[]): Promise<void>

- Defined in crazyflie/toc-fetcher.ts:195
Save a TOC to cache

Parameters
- crc: number
- items: TOCItem[]
Returns Promise<void>

clearCache

clearCache(): Promise<void>

- Defined in crazyflie/toc-fetcher.ts:241
Deletes cache

Returns Promise<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>

Private fetchRemainingTOCItems

fetchRemainingTOCItems(): Promise<void>

- Defined in crazyflie/toc-fetcher.ts:107
Loop through all TOC ids and see if we already have it. If not, retrieve it.

Returns Promise<void>

Private fetchTOCItem

fetchTOCItem(id: number): Promise<Object>

- Defined in crazyflie/toc-fetcher.ts:124
Fetch TOC item from the Crazyflie (https://wiki.bitcraze.io/doc:crazyflie:crtp:log#get_toc_item)

Parameters
- id: number
Returns Promise<Object>

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

getTOCCache

getTOCCache(): Promise<TOCCache>

- Defined in crazyflie/toc-fetcher.ts:227
Gets the complete TOC cache Will return null if file doesn't exist or invalid JSON

Returns Promise<TOCCache>

getTOCFromCache

getTOCFromCache(crc: number): Promise<TOC>

- Defined in crazyflie/toc-fetcher.ts:212
Get TOC from cache according to cyclic redundancy check (checksum) value Will return null if no crc in cache

Parameters
- crc: number
Returns Promise<TOC>

handleTOCInfo

handleTOCInfo(data: Buffer): Promise<void>

- Defined in crazyflie/toc-fetcher.ts:75
Parameters
- data: Buffer
Returns Promise<void>

handleTOCItem

handleTOCItem(data: Buffer): Promise<void>

- Defined in crazyflie/toc-fetcher.ts:145
Handle TOC item response (https://wiki.bitcraze.io/doc:crazyflie:crtp:log#get_toc_item)

Parameters
- data: Buffer
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

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

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

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

start

start(): Promise<TOC>

- Defined in crazyflie/toc-fetcher.ts:64
Returns Promise<TOC>

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