CANOPEN_CLIENT Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Namespaces | Macros | Functions
canopen_client_kconfig.hpp File Reference

Optional ESP-IDF layer: a Config built from the CONFIG_CANOPEN_CLIENT_* Kconfig options. More...

#include "canopen_client_types.hpp"

Go to the source code of this file.

Namespaces

namespace  canopen_client
 The CANopen client driver: everything it declares lives here; internals in detail.
 

Macros

#define CONFIG_CANOPEN_CLIENT_SDO_TIMEOUT_MS   200
 
#define CONFIG_CANOPEN_CLIENT_GUARD_TIMEOUT_MS   100
 
#define CONFIG_CANOPEN_CLIENT_DRIVE_TIMEOUT_MS   2000
 
#define CONFIG_CANOPEN_CLIENT_DRIVE_POLL_INTERVAL_MS   10
 
#define CONFIG_CANOPEN_CLIENT_SAFETY_ATTEMPTS   3
 

Functions

constexpr Config canopen_client::KconfigDefaults () noexcept
 The configuration menuconfig selected, on top of the defaults.
 

Detailed Description

Optional ESP-IDF layer: a Config built from the CONFIG_CANOPEN_CLIENT_* Kconfig options.

Include it only where menuconfig should choose the defaults; without Kconfig KconfigDefaults() equals Config{}. One configuration per program: every translation unit of one program must see the same CONFIG_ values, and no driver header includes this one (handbook KB-CPP20-018).

Macro Definition Documentation

◆ CONFIG_CANOPEN_CLIENT_DRIVE_POLL_INTERVAL_MS

#define CONFIG_CANOPEN_CLIENT_DRIVE_POLL_INTERVAL_MS   10

Pause between statusword reads when Kconfig does not set it.

◆ CONFIG_CANOPEN_CLIENT_DRIVE_TIMEOUT_MS

#define CONFIG_CANOPEN_CLIENT_DRIVE_TIMEOUT_MS   2000

Drive state change timeout when Kconfig does not set it.

◆ CONFIG_CANOPEN_CLIENT_GUARD_TIMEOUT_MS

#define CONFIG_CANOPEN_CLIENT_GUARD_TIMEOUT_MS   100

Node-guarding reply timeout when Kconfig does not set it.

◆ CONFIG_CANOPEN_CLIENT_SAFETY_ATTEMPTS

#define CONFIG_CANOPEN_CLIENT_SAFETY_ATTEMPTS   3

Sends of a stop or disable command when Kconfig does not set it.

◆ CONFIG_CANOPEN_CLIENT_SDO_TIMEOUT_MS

#define CONFIG_CANOPEN_CLIENT_SDO_TIMEOUT_MS   200

SDO reply timeout when Kconfig does not set it: Config{}.sdo_timeout_us in milliseconds.