Class PeripheralCANBus

CAN Bus

Hierarchy

ComponentAbstract
- PeripheralCANBus

Index

Constructors

constructor

new PeripheralCANBus(obniz, id): PeripheralCANBus
Parameters
- obniz: Obniz
- id: number
Returns PeripheralCANBus
Overrides ComponentAbstract.constructor
- Defined in src/obniz/libs/io_peripherals/canbus.ts:99

Properties

Obniz

Obniz: Obniz

obniz to be used

`Optional` onreceive

onreceive?: ((extended, rtr, id, data) => void)

Type declaration

(extended, rtr, id, data): void

It is called when data is received. Data is array of bytes.

// Javascript Example
obniz.canbus0.start({mode:"normal", tx :0, rx:1, kbps:100, filter_code: 0, filter_mask: 0});
obniz.canbus0.onreceive = function(extended, rtr, id, data) {
  console.log(data);
}

Parameters

extended: boolean
rtr: boolean
id: number
data: number[]

Returns void

timeout

timeout: number = ...

Rsponse waiting timeout in milliseconds

`Static` prefixed

prefixed: string | boolean

Methods

addListener

addListener(event, fn, context?): PeripheralCANBus
Parameters
- event: string
- fn: ListenerFn
- Optional context: any
Returns PeripheralCANBus
Inherited from ComponentAbstract.addListener
- Defined in node_modules/eventemitter3/index.d.ts:33

emit

emit(event, ...args): boolean
Calls each of the listeners registered for a given event.
Parameters
- event: string
- Rest ...args: any[]
Returns boolean
Inherited from ComponentAbstract.emit
- Defined in node_modules/eventemitter3/index.d.ts:27

end

end(): void

It ends canbus

// Javascript Example
obniz.canbus0.start({mode:"normal", tx :0, rx:1, kbps:100, filter_code: 0, filter_mask: 0});
obniz.canbus0.end();

Returns void

eventNames

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

Returns string[]
Inherited from ComponentAbstract.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:12

fastValidate

fastValidate(commandUri, json): boolean
Parameters
- commandUri: any
- json: any
Returns boolean
Inherited from ComponentAbstract.fastValidate
- Defined in src/obniz/libs/ComponentAbstact.ts:91

listenerCount

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

listeners

listeners(event): ListenerFn[]
Return the listeners registered for a given event.
Parameters
- event: string
Returns ListenerFn[]
Inherited from ComponentAbstract.listeners
- Defined in node_modules/eventemitter3/index.d.ts:17

notifyFromObniz

notifyFromObniz(json): void
Parameters
- json: any
Returns void
Inherited from ComponentAbstract.notifyFromObniz
- Defined in src/obniz/libs/ComponentAbstact.ts:53

off

off(event, fn?, context?, once?): PeripheralCANBus
Parameters
- event: string
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns PeripheralCANBus
Inherited from ComponentAbstract.off
- Defined in node_modules/eventemitter3/index.d.ts:44

on

on(event, fn, context?): PeripheralCANBus
Add a listener for a given event.
Parameters
- event: string
- fn: ListenerFn
- Optional context: any
Returns PeripheralCANBus
Inherited from ComponentAbstract.on
- Defined in node_modules/eventemitter3/index.d.ts:32

once

once(event, fn, context?): PeripheralCANBus
Add a one-time listener for a given event.
Parameters
- event: string
- fn: ListenerFn
- Optional context: any
Returns PeripheralCANBus
Inherited from ComponentAbstract.once
- Defined in node_modules/eventemitter3/index.d.ts:38

removeAllListeners

removeAllListeners(event?): PeripheralCANBus
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string
Returns PeripheralCANBus
Inherited from ComponentAbstract.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:49

removeListener

removeListener(event, fn?, context?, once?): PeripheralCANBus
Remove the listeners of a given event.
Parameters
- event: string
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns PeripheralCANBus
Inherited from ComponentAbstract.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:43

send

send(modes, id, data): void
It only sends data to canbus and does not receive it.
```
// Javascript Example
obniz.canbus0.start({mode:"normal", tx :0, rx:1, kbps:100, filter_code: 0, filter_mask: 0});
obniz.canbus0.send({}, 0x700, [0x12, 0x98]);
```
Parameters
- modes: CANBusSendModes
- id: number
- data: number[]
  
  Max length is 1024 bytes.
Returns void
- Defined in src/obniz/libs/io_peripherals/canbus.ts:181

start

start(params): void
Start CAN Bus
```
// Javascript Example
obniz.canbus0.start({mode:"normal", tx :0, rx:1, kbps:100, filter_code: 0, filter_mask: 0});
```
Parameters
- params: PeripheralCANBusOptions
  
  CAN Bus parameters
Returns void
- Defined in src/obniz/libs/io_peripherals/canbus.ts:128

validate

validate(commandUri, json): MultiResult
Parameters
- commandUri: any
- json: any
Returns MultiResult
Inherited from ComponentAbstract.validate
- Defined in src/obniz/libs/ComponentAbstact.ts:86

Class PeripheralCANBus

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

obniz: Obniz

id: number

Returns PeripheralCANBus

Properties

Obniz

Optional onreceive

Type declaration

Parameters

extended: boolean

rtr: boolean

id: number

data: number[]

Returns void

timeout

Static prefixed

Methods

addListener

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns PeripheralCANBus

emit

Parameters

event: string

Rest ...args: any[]

Returns boolean

end

Returns void

eventNames

Returns string[]

fastValidate

Parameters

commandUri: any

json: any

Returns boolean

listenerCount

Parameters

event: string

Returns number

listeners

Parameters

event: string

Returns ListenerFn[]

notifyFromObniz

Parameters

json: any

Returns void

off

Parameters

event: string

Optional fn: ListenerFn

Optional context: any

Optional once: boolean

Returns PeripheralCANBus

on

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns PeripheralCANBus

once

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns PeripheralCANBus

removeAllListeners

Parameters

Optional event: string

Returns PeripheralCANBus

`Optional` onreceive

`Static` prefixed

`Optional` context: any

`Rest` ...args: any[]

`Optional` fn: ListenerFn

`Optional` context: any

`Optional` once: boolean

`Optional` context: any

`Optional` context: any

`Optional` event: string

`Optional` fn: ListenerFn

`Optional` context: any

`Optional` once: boolean