dpyEcu Namespace Reference

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

Classes

struct  Alarm
 Alarm info. More...
 
struct  AlarmEvent
 Alarm event. More...
 
struct  CANBusConfiguration
 CAN BUS configuration structure. More...
 
struct  CANBusFilter
 Can bus filter structure. More...
 
struct  CANBusFrame
 It contains the CAN Bus Frame structure. More...
 
struct  ECUInfoConf
 
struct  Parameter
 Parameter information. More...
 
struct  Protocol
 ECU Protocol info. More...
 

Typedefs

typedef boost::function< void(boost::system::error_code error_code)> result_handler_function
 Prototype of the handler function for obtaining a result. More...
 
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 &ec, std::vector< dpyEcu::Parameter > params)> parameters_handler_function
 Handler for vehicle information. This type of function is called when the status callback is done. More...
 
typedef boost::function< void(boost::system::error_code &ec, std::vector< std::string > EPIDs)> epids_handler_function
 Handler for vehicle available parameters. This type of function is called when the status callback is done. More...
 
typedef boost::function< void(boost::system::error_code &ec, uint16_t id)> confirmation_alarm_handler_function
 Handler for status function callback. This type of function is called when the status callback is done. More...
 
typedef boost::function< void(boost::system::error_code &ec, std::vector< dpyEcu::Alarm > alarms)> alarms_handler_function
 Handler for status function callback. This type of function is called when the status callback is done. More...
 
typedef boost::function< void(boost::system::error_code &ec, dpyEcu::Protocol protocols)> protocols_handler_function
 Handler for protocols function callback. This type of function is called when the get protocols callback is done. More...
 
typedef boost::function< void(boost::system::error_code &ec, std::pair< dpyEcu::Alarm, dpyEcu::Parameter > alarm_event)> alarm_event_handler_function
 Handler for alarm event function callback. This type of function is called when the ecuAlarmEvent_S callback is done. More...
 
typedef boost::function< void(boost::system::error_code &ec, dpyEcu::CANBusFrame frame)> can_bus_message_handler_function
 Handler for CAN bus message function callback. This type of function is called when a CAN bus frame is received. More...
 

Enumerations

enum  CANBusFilterOperation { RESET = 0, ADD = 1, REMOVE = 2 }
 CAN bus filter operation.
 
enum  CANBusIdType { STANDARD = 0, EXTENDED = 1, J1939 = 2, CUSTOM = 3 }
 CAN bus frame type.
 
enum  AlarmType { STATE_CHANGE = 0, THRESHOLD = 1 }
 Type of ECU alarm. More...
 

Typedef Documentation

typedef boost::function<void(boost::system::error_code& ec, std::pair<dpyEcu::Alarm, dpyEcu::Parameter> alarm_event)> alarm_event_handler_function
Parameters
ecerror code
pairof data with Alarm and the Parameter associated to it
typedef boost::function<void(boost::system::error_code& ec, std::vector<dpyEcu::Alarm> alarms)> alarms_handler_function
Parameters
ecerror code
listof configured alarms
typedef boost::function<void(boost::system::error_code& ec, dpyEcu::CANBusFrame frame)> can_bus_message_handler_function
Parameters
ecerror code
frameCAN message
typedef boost::function<void(boost::system::error_code& ec, uint16_t id)> confirmation_alarm_handler_function
Parameters
ecerror code
idof the alarm configured
typedef boost::function<void(boost::system::error_code& ec, std::vector<std::string> EPIDs)> epids_handler_function
Parameters
ecerror code
epidswith the requested information.
typedef boost::function<void(boost::system::error_code& ec, std::vector<dpyEcu::Parameter> params)> parameters_handler_function
Parameters
ecerror code
paramswith the requested information.
typedef boost::function<void(boost::system::error_code& ec, dpyEcu::Protocol protocols)> protocols_handler_function
Parameters
ecerror code
listof available protocols
typedef boost::function<void(boost::system::error_code error_code)> result_handler_function
Parameters
error_codeerror code (if any)
typedef boost::function<void(const bool &available)> service_availability_handler
Parameters
availabletrue if the service is available, false otherwisePrototype of the handler function for monitorServiceAvailability method

Enumeration Type Documentation

enum AlarmType
Enumerator
STATE_CHANGE 

Alarm when the state of the param changes.

THRESHOLD 

Alarm set by threshold.