Class CanCommunication

ClassList > CanCommunication

Public Static Functions

Type	Name
bool	getBroadcastEnable () Get the Broadcasting enable status.
uint16_t	getBroadcastPeriod () Get the broadcast period.
uint16_t	getCanNodeAddr () Get the CAN node address.
uint16_t	getControlPeriod () Get the control period.
bool	getCtrlEnable () Get the control enable status.
float32_t	getCtrlReference () Get the control reference value.
float32_t	getStartStopState () Get the start - stop current order.
void	setBroadcastEnable (bool enable) Set the Broadcasting enable status.
void	setBroadcastPeriod (uint16_t time_s) Set the broadcast period.
void	setCanNodeAddr (uint16_t addr) Set the CAN node address.
void	setControlPeriod (uint16_t time_ms) Set the control period.
void	setCtrlEnable (bool enable) Set the control enable status.
void	setCtrlReference (float32_t reference) Set the control reference value.
void	startSlaveDevice () Set the order to start slave devices.
void	stopSlaveDevice () Set the order to stop slave devices.

Public Static Functions Documentation

function getBroadcastEnable

Get the Broadcasting enable status.

static bool CanCommunication::getBroadcastEnable () 

Returns:

True if broadcasting is enabled, false otherwise.

---

function getBroadcastPeriod

Get the broadcast period.

static uint16_t CanCommunication::getBroadcastPeriod () 

Returns:

The broadcast period in seconds (s).

---

function getCanNodeAddr

Get the CAN node address.

static uint16_t CanCommunication::getCanNodeAddr () 

Returns:

The CAN node address.

---

function getControlPeriod

Get the control period.

static uint16_t CanCommunication::getControlPeriod () 

Returns:

The control period in milli seconds (ms).

---

function getCtrlEnable

Get the control enable status.

static bool CanCommunication::getCtrlEnable () 

Returns:

True if control is enabled, false otherwise.

---

function getCtrlReference

Get the control reference value.

static float32_t CanCommunication::getCtrlReference () 

Returns:

The control reference value.

---

function getStartStopState

Get the start - stop current order.

static float32_t CanCommunication::getStartStopState () 

Returns:

A boolean that is 1 is current order is start, 0 if stop.

---

function setBroadcastEnable

Set the Broadcasting enable status.

static void CanCommunication::setBroadcastEnable (
    bool enable
) 

Parameters:

• enable True to enable broadcasting, false to disable it.

---

function setBroadcastPeriod

Set the broadcast period.

static void CanCommunication::setBroadcastPeriod (
    uint16_t time_s
) 

Parameters:

• time_s The broadcast period in seconds (s).

---

function setCanNodeAddr

Set the CAN node address.

static void CanCommunication::setCanNodeAddr (
    uint16_t addr
) 

Parameters:

• addr The CAN node address to set.

---

function setControlPeriod

Set the control period.

static void CanCommunication::setControlPeriod (
    uint16_t time_ms
) 

Parameters:

• time_ms The control period in milli seconds (ms).

---

function setCtrlEnable

Set the control enable status.

static void CanCommunication::setCtrlEnable (
    bool enable
) 

Parameters:

• enable True to enable control, false to disable it.

---

function setCtrlReference

Set the control reference value.

static void CanCommunication::setCtrlReference (
    float32_t reference
) 

Parameters:

• reference The control reference value to set.

---

function startSlaveDevice

Set the order to start slave devices.

static void CanCommunication::startSlaveDevice () 

---

function stopSlaveDevice

Set the order to stop slave devices.

static void CanCommunication::stopSlaveDevice () 

---

---

The documentation for this class was generated from the following file docs/core/zephyr/modules/owntech_communication/zephyr/src/CanCommunication.h