@kvaser/canking-api
Version:
CanKing API to communicate with the CanKing service using Node.js.
79 lines (45 loc) • 1.56 kB
Markdown
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md)
***
[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / CanBusParams
# Interface: CanBusParams
CanBusParams is used for getting the channels bus params capacity and it can be used for
setting up a correct bus speed configuration for a specific CAN channel.
Constraints that must be fulfilled when opening channel in classic CAN Mode:
tq = 1 + prop + phase1 + phase2
tq >= 3
sjw <= min(phase1, phase2)
prescaler >= 1
Constraints that must be fulfilled when opening channel in CAN FD Mode:
arbitration.tq = 1 + arbitration.prop + arbitration.phase1 + arbitration.phase2
arbitration.tq >= 3
arbitration.sjw <= min(arbitration.phase1, arbitration.phase2)
arbitration.prescaler >= 1 (<=2 will enable Transmitter Delay Compensation Mechanism)
data.tq = 1 + data.phase1 + data.phase2
data.tq >= 3
data.sjw <= min(data.phase1, data.phase2)
data.prop = 0
data.prescaler = arbitration.prescaler
## Properties
### phase1
> **phase1**: `number`
The number of time quantas in phase 1.
***
### phase2
> **phase2**: `number`
The number of time quantas in phase 2.
***
### prescaler
> **prescaler**: `number`
The prescaler value.
***
### prop
> **prop**: `number`
The propagation segment in time quantas.
***
### sjw
> **sjw**: `number`
The synchronization jump width in time quantas.
***
### tq
> **tq**: `number`
The total number of time quantas (TQ).