dpyMcu Namespace Reference

Deepsy Mcu namespace that includes the different enums, structs or method signatures that should be used.

Classes

struct  BatteryProtectionConfig
 Battery Protection Config struct which contains the response received from the service. More...
 
struct  CANBusConfiguration
 CAN BUS configuration structure. More...
 
struct  CANBusFilter
 
struct  CANBusFrame
 It contains the CAN Bus Frame structure. More...
 
struct  CanStatusEvent
 It contains the current CAN Bus status defined in its timestamp. More...
 
struct  DateConfig
 DateConfig struct which contains the response received from the service. More...
 
struct  GpioConfig
 GPIO Struct which contains the response received from the service. More...
 
struct  GUIDConfig
 GUID struct which contains the response received from the service. More...
 
struct  GUIDConfigList
 GUID list struct which contains the response received from the service. More...
 
struct  I2CValue
 I2C Struct which contains the response received from the service. More...
 
struct  LedsConfig
 
struct  MCUStatus
 MCU Status struct which contains the response received from the service. More...
 
struct  PowerInformationConfig
 PowerInformation struct which contains the response received from the service. More...
 
struct  PowerStateConfig
 PowerInformation struct which contains the response received from the service. More...
 
struct  SerialPortProtocolConfig
 Serial Port protocol configuration structure. More...
 
struct  TimersConfig
 Timers struct which contains the response received from the service. More...
 
struct  UpdateConfig
 Update struct which contains the response received from the service. More...
 
struct  WorkingTimeConfig
 Working Time struct which contains the response received from the service. More...
 

Typedefs

typedef boost::function< void(const bool &available)> service_availability_handler
 Prototype of the handler function used to monitor service availability. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::PowerInformationConfig &)> power_mng_handler_function
 Prototype of the handler function for obtaining the Power Information. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::LedsConfig &)> leds_handler_function
 Prototype of the handler function for obtaining the LEDs configuration. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::PowerStateConfig &)> power_states_handler_function
 Prototype of the handler function for obtaining the Power State Configuration. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::TimersConfig &)> timers_handler_function
 Prototype of the handler function for obtaining the Timers Configuration. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::UpdateConfig &)> update_firmware_handler_function
 Prototype of the handler function for obtaining the updated configuration. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::GUIDConfigList &)> guid_handler_function
 Prototype of the handler function for obtaining the GUIDs. More...
 
typedef boost::function< void(boost::system::error_code error_code, char &, char &)> eqvar_handler_function
 Prototype of the handler function for obtaining the GUIDs. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::WorkingTimeConfig &)> working_time_handler_function
 Prototype of the handler function for obtaining the Working Time Values. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::MCUStatus &)> mcu_status_handler_function
 Prototype of the handler function for obtaining the MCU Status. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::BatteryProtectionConfig &)> battery_protection_handler_function
 Prototype of the handler function for obtaining the Battery Protection Configuration. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::DateConfig &)> rtc_date_handler_function
 Prototype of the handler function for obtaining the RTC Date Configuration. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::GpioConfig &)> gpio_handler_function
 Prototype of the handler function for obtaining the GPIO Configuration. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::GpiosAvailable &)> gpios_events_handler_function
 Prototype of the handler function for obtaining the GPIO Events. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::I2CValue &)> i2c_handler_function
 Prototype of the handler function for obtaining the I2C information. More...
 
typedef boost::function< void(boost::system::error_code error_code, const dpyFirmware::FirmwareVersionInfo &fw_version)> version_handler_function
 Prototype of the handler function for obtaining the fw version. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::CanStatusEvent &)> can_status_handler_function
 Prototype of the handler function for obtaining the CAN Status Information. More...
 
typedef boost::function< void(boost::system::error_code error_code)> test_misc_handler_function
 Prototype of the handler function for obtaining the current MISC status. More...
 
typedef boost::function< void(boost::system::error_code error_code)> set_power_button_state_handler_function
 Prototype of the handler function for obtaining the result of power button. More...
 
typedef boost::function< void(boost::system::error_code error_code, bool enabled)> get_power_button_state_handler_function
 Prototype of the handler function for obtaining the result of power button. More...
 
typedef boost::function< void(boost::system::error_code error_code)> result_handler_function
 Prototype of the handler function for obtaining the result of the operations status. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::SerialPortProtocolConfig &)> serialport_handler_function
 Prototype of the handler function for setting the Serial Port Protocol. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyMcu::CANBusFrame frame)> get_can_bus_message_handler_function
 Prototype of the handler function for getting CAN Bus Messages. More...
 

Enumerations

enum  CanStatus {
  TX_BUSY = 0, TX_IDLE = 1, RX_BUSY = 2, RX_IDLE = 3,
  RX_FIFO0_NEW = 4, RX_FIFO0_IDLE = 5, RX_FIFO0_WATERMARK = 6, RX_FIFO0_FULL = 7,
  RX_FIFO0_LOST = 8, RX_FIFO1_NEW = 9, RX_FIFO1_IDLE = 10, RX_FIFO1_WATERMARK = 11,
  RX_FIFO1_FULL = 12, RX_FIFO1_LOST = 13, RX_FIFO0_BUSY = 14, RX_FIFO1_BUSY = 15,
  ERROR_STATUS = 16, UNHANDLED = 17
}
 Different CAN Bus tatus. More...
 
enum  CANBusIdType { STANDARD = 0, EXTENDED = 1 }
 
enum  SerialPortProtocol { RS485 = 0, RS232 = 1 }
 Serial Ports Protocol. More...
 
MCU information

This enumerations give easy access to the main parameters that describe the MCU parameters in a given moment

enum  LedsColor {
  RED = 1, BLUE = 2, GREEN = 3, MAGENTA = 4,
  YELLOW = 5, CYAN = 6, UNDEFINED = 7
}
 Possible color to be set. More...
 
enum  PowerStates {
  N_A = 1, POWER_ON = 2, REBOOT = 3, STANDBY = 4,
  HALT = 5, ABORT = 6, CRITICAL_BATTERY = 7
}
 Possible power state to be set. More...
 
enum  GpiosAvailable {
  GPI1 = 1, GPI2 = 2, GPI3 = 3, GPI4 = 4,
  GPI5 = 5, GPI6 = 6, GPI7 = 7, GPI8 = 8,
  BUTTON1 = 9, BUTTON2 = 10, BUTTON3 = 11, BUTTON4 = 12,
  BUTTON5 = 13, BUTTON6 = 14, BUTTON7 = 15, BUTTON8 = 16,
  POWER_BUTTON = 17, ODO = 18, ODO_REDU = 19, GPO1 = 21,
  GPO2 = 22, GPO3 = 23, GPO4 = 24, GPO5 = 25,
  GPO6 = 26, GPO7 = 27, GPO8 = 28
}
 Possible color to be set. More...
 
enum  Result { OK = 0, ERROR = 1 }
 Possible received result. More...
 

Typedef Documentation

typedef boost::function<void(boost::system::error_code error_code, dpyMcu::BatteryProtectionConfig &)> battery_protection_handler_function
Parameters
error_codeerror code (if any)
BatteryProtectionConfig
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::CanStatusEvent &)> can_status_handler_function
Parameters
error_codeerror code (if any)
PowerInformationConfig
typedef boost::function<void(boost::system::error_code error_code, char &, char &)> eqvar_handler_function
Parameters
error_codeerror code (if any)
eq_id
var_id
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::CANBusFrame frame)> get_can_bus_message_handler_function
Parameters
error_codeerror code (if any)
CANBus Frame
typedef boost::function<void(boost::system::error_code error_code, bool enabled)> get_power_button_state_handler_function
Parameters
error_codeerror code (if any)
enabled
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::GpioConfig &)> gpio_handler_function
Parameters
error_codeerror code (if any)
GpioConfig
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::GpiosAvailable &)> gpios_events_handler_function
Parameters
error_codeerror code (if any)
GpioConfig
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::GUIDConfigList &)> guid_handler_function
Parameters
error_codeerror code (if any)
GUIDConfig
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::I2CValue &)> i2c_handler_function
Parameters
error_codeerror code (if any)
GpioConfig
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::LedsConfig &)> leds_handler_function
Parameters
error_codeerror code (if any)
LedsConfig
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::MCUStatus &)> mcu_status_handler_function
Parameters
error_codeerror code (if any)
MCUStatus
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::PowerInformationConfig &)> power_mng_handler_function
Parameters
error_codeerror code (if any)
PowerInformationConfig
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::PowerStateConfig &)> power_states_handler_function
Parameters
error_codeerror code (if any)
PowerStateConfig
typedef boost::function<void(boost::system::error_code error_code)> result_handler_function
Parameters
error_codeerror code (if any)
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::DateConfig &)> rtc_date_handler_function
Parameters
error_codeerror code (if any)
DateConfig
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::SerialPortProtocolConfig &)> serialport_handler_function
Parameters
error_codeerror code (if any)
SerialPortProtocolConfig
typedef boost::function<void(const bool &available)> service_availability_handler
Parameters
availabletrue if the service is available, false otherwise
typedef boost::function<void(boost::system::error_code error_code)> set_power_button_state_handler_function
Parameters
error_codeerror code (if any)
typedef boost::function<void(boost::system::error_code error_code)> test_misc_handler_function
Parameters
error_codeerror code (if any)
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::TimersConfig &)> timers_handler_function
Parameters
error_codeerror code (if any)
TimersConfig
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::UpdateConfig &)> update_firmware_handler_function
Parameters
error_codeerror code (if any)
UpdateConfig
typedef boost::function<void(boost::system::error_code error_code, const dpyFirmware::FirmwareVersionInfo& fw_version)> version_handler_function
Parameters
error_codeerror code (if any)
fw_versionfirmware version
typedef boost::function<void(boost::system::error_code error_code, dpyMcu::WorkingTimeConfig &)> working_time_handler_function
Parameters
error_codeerror code (if any)
WorkingTimeConfig

Enumeration Type Documentation

enum CanStatus
Enumerator
TX_BUSY 

Tx Buffer is Busy.

TX_IDLE 

Tx Buffer is Idle.

RX_BUSY 

Rx Buffer is Busy.

RX_IDLE 

Rx Buffer is Idle.

RX_FIFO0_NEW 

New message written to Rx FIFO 0.

RX_FIFO0_IDLE 

Rx FIFO 0 is Idle.

RX_FIFO0_WATERMARK 

Rx FIFO 0 fill level reached watermark.

RX_FIFO0_FULL 

Rx FIFO 0 full.

RX_FIFO0_LOST 

Rx FIFO 0 message lost.

RX_FIFO1_NEW 

New message written to Rx FIFO 1.

RX_FIFO1_IDLE 

Rx FIFO 1 is Idle.

RX_FIFO1_WATERMARK 

Rx FIFO 1 fill level reached watermark.

RX_FIFO1_FULL 

Rx FIFO 1 full.

RX_FIFO1_LOST 

Rx FIFO 1 message lost.

RX_FIFO0_BUSY 

Rx FIFO 0 is busy.

RX_FIFO1_BUSY 

Rx FIFO 1 is busy.

ERROR_STATUS 

MCAN Module Error and Status.

UNHANDLED 

UnHadled Interrupt asserted.

Enumerator
GPI1 

GPI1.

GPI2 

GPI2.

GPI3 

GPI3.

GPI4 

GPI4.

GPI5 

GPI5.

GPI6 

GPI6.

GPI7 

GPI7.

GPI8 

GPI8.

BUTTON1 

BUTTON1.

BUTTON2 

BUTTON2.

BUTTON3 

BUTTON3.

BUTTON4 

BUTTON4.

BUTTON5 

BUTTON5.

BUTTON6 

BUTTON6.

BUTTON7 

BUTTON7.

BUTTON8 

BUTTON8.

POWER_BUTTON 

POWER_BUTTON.

ODO 

ODO.

ODO_REDU 

ODO_REDU.

GPO1 

GPO1.

GPO2 

GPO2.

GPO3 

GPO3.

GPO4 

GPO4.

GPO5 

GPO5.

GPO6 

GPO6.

GPO7 

GPO7.

GPO8 

GPO8.

enum LedsColor
Enumerator
RED 

RED.

BLUE 

BLUE.

GREEN 

GREEN.

MAGENTA 

MAGENTA.

YELLOW 

YELLOW.

CYAN 

CYAN.

UNDEFINED 

UNDEFINED.

Enumerator
N_A 

Not Available.

POWER_ON 

Power On.

REBOOT 

Reboot.

STANDBY 

Standby.

HALT 

Halt.

ABORT 

Abort.

CRITICAL_BATTERY 

Critical battery.

enum Result
Enumerator
OK 

OK.

ERROR 

ERROR.

Enumerator
RS485 

485

RS232 

232