Class which interfaces with the API logic.

#include <mcuApiPrivate.h>

Inheritance diagram for McuPrivate:

Public Member Functions
	McuPrivate (std::string ip="127.0.0.1")
	Constructor of the class. More...

virtual	~McuPrivate ()
	Destructor of the class.

boost::system::error_code	subscribe (CANBusObserver *observer)
	Adds an observer to notification list. More...

boost::system::error_code	unsubscribe (CANBusObserver *observer)
	Removes an observer from notification list. More...

void	asyncSetPowerStateConfig (dpyMcu::power_states_handler_function handler, dpyMcu::PowerStates state, std::uint32_t flags)
	Method which requests to change Power State of OBU. More...

void	asyncSetTimersConfig (dpyMcu::timers_handler_function handler, std::uint32_t standby_min, std::uint32_t halt_min)
	Method which requests to change Standby and Halt Timers. More...

void	asyncSetRtcDateConfig (dpyMcu::rtc_date_handler_function handler, dpyMcu::DateConfig configDate)
	Method which requests to set RTC date configuration values. More...

boost::system::error_code	setRtcDateConfig (dpyMcu::DateConfig configDate)
	Method which requests to set RTC date configuration values. More...

void	asyncTestMisc (dpyMcu::test_misc_handler_function handler)
	Method which requests the current MISC status. More...

void	asyncSetGpoDefValue (dpyMcu::gpio_handler_function handler, std::uint32_t gpo_number, bool gpo_value)
	Method which allows to set default value for a GPO. More...

boost::system::error_code	setGpoDefValue (std::uint32_t gpo_number, bool gpo_value)
	Synchronous method which allows to set default value for a GPO. More...

void	asyncGetGpoDefValue (dpyMcu::gpio_handler_function handler, std::uint32_t gpo_number)
	Method which allows to get default value of a GPO. More...

void	asyncSetSerialPortProtocol (dpyMcu::serialport_handler_function handler, const std::string &portid, dpyMcu::SerialPortProtocol protocol)
	Method to set serial protocol to MCU-placed serial ports. More...

void	asyncEnablePowerButton (dpyMcu::set_power_button_state_handler_function handler)
	Method which enables the Power Button. More...

void	asyncDisablePowerButton (dpyMcu::set_power_button_state_handler_function handler)
	Method which disables the Power Button. More...

void	asyncGetPowerButtonState (dpyMcu::get_power_button_state_handler_function handler)
	Method which gets Power Button state. More...

void	asyncSetCanBusFilters (dpyMcu::result_handler_function handler, std::list< dpyMcu::CANBusFilter > &filter_list)
	Method to set CAN bus filters to MCU device. More...

void	asyncResetCanBusFilters (dpyMcu::result_handler_function handler)
	Method to reset CAN bus filters in MCU device. More...

boost::system::error_code	setCanBusFilters (std::list< dpyMcu::CANBusFilter > &filter_list)
	Method to set CAN bus filters to MCU device. More...

boost::system::error_code	resetCanBusFilters ()
	Method to reset CAN bus filters in MCU device. More...

void	asyncSetCanBusConfiguration (dpyMcu::result_handler_function handler, dpyMcu::CANBusConfiguration conf)
	Method to set CAN bus configuration to MCU device. More...

boost::system::error_code	setCanBusConfiguration (dpyMcu::CANBusConfiguration conf)
	Method to set CAN bus configuration to MCU device. More...

void	asyncResetMcu (dpyMcu::result_handler_function handler)
	Method to reset MCU. More...

Public Member Functions inherited from Mcu
	Mcu (std::string ip="127.0.0.1")
	Constructor of the class. More...

virtual	~Mcu ()
	Destructor of the class.

bool	isAlive ()
	Method to check if MCU Service is Alive. More...

void	monitorServiceAvailability_S (dpyMcu::service_availability_handler handler)

void	monitorServiceAvailability_U ()

void	asyncGetLedsConfig (dpyMcu::leds_handler_function handler)
	Method which requests the LED color state. More...

void	asyncSetLedsConfig (dpyMcu::leds_handler_function handler, dpyMcu::LedsColor color, std::uint32_t period, std::uint32_t duty_cycle)
	Method which requests to change the LED color state. More...

void	asyncSetBatteryProtectionConfig (dpyMcu::battery_protection_handler_function handler, float idle_voltage, float voltage_percentage_threshold, float hysteresis_percentage, std::uint32_t grace_period_minutes)
	Method which requests to set battery protection configuration values. More...

void	asyncGetBatteryProtectionConfig (dpyMcu::battery_protection_handler_function handler)
	Method which requests to get battery protection configuration values. More...

void	asyncGetRtcDateConfig (dpyMcu::rtc_date_handler_function handler)
	Method which requests to get RTC date configuration values. More...

boost::system::error_code	getRtcDateConfig (dpyMcu::DateConfig &config)
	Method which requests to get RTC date configuration values. More...

void	asyncGetTimersConfig (dpyMcu::timers_handler_function handler)
	Method which requests one message with Standby and Halt Timers. More...

void	asyncUpdateMCU (dpyMcu::update_firmware_handler_function handler)
	Method which updates the firmware of the MCU (the new image must be in the right PATH of the system) More...

void	asyncGetGUIDValues (dpyMcu::guid_handler_function handler)
	Method which requests one message with Part Number, Serial Number and CIDL of the equipment. More...

virtual boost::system::error_code	getGUIDValues (dpyMcu::GUIDConfigList &guid_list)
	Method which requests to get GUID values. More...

void	asyncGetEQVar (dpyMcu::eqvar_handler_function handler)
	Method which requests to get EQ/Var values. More...

virtual boost::system::error_code	getEQVar (char &eq_id, char &var_id)
	Method which requests to get EQ/Var values. More...

void	asyncGetWorkingTimeValues (dpyMcu::working_time_handler_function handler)
	Method which requests one message with the Power-On, Standby and Halt States working hours. More...

void	asyncGetMCUStatus (dpyMcu::mcu_status_handler_function handler)
	Method which gets one message indicating hardware and software exceptions coming from MCU. More...

void	getPowerInformation_S (dpyMcu::power_mng_handler_function handler)
	Method which receives one message with Power information coming from the service periodically. More...

void	asyncGetPowerInformation (dpyMcu::power_mng_handler_function handler)
	Method which requests one message with Power information coming from the service periodically. More...

void	asyncGetGpioValue (dpyMcu::gpio_handler_function handler, std::uint32_t gpio_number)
	Method which requests one message with GPIO information. More...

void	asyncSetGpioValue (dpyMcu::gpio_handler_function handler, std::uint32_t gpio_number, bool gpio_value)
	Method which requests to set a GPIO pin with a value. More...

void	asyncGetGpiosEvents (dpyMcu::gpios_events_handler_function handler)
	Method which receives one message with Gpios events coming from the service. More...

void	asyncGetI2CValue (dpyMcu::i2c_handler_function handler, unsigned char busid, unsigned char deviceid, std::list< unsigned char > address, int lenght)
	Method which requests one message with I2C information. More...

void	asyncSetI2CValue (dpyMcu::i2c_handler_function handler, unsigned char busid, unsigned char deviceid, std::list< unsigned char > address, std::list< unsigned char > values)
	Method which requests to set a I2C address pin with a value. More...

void	asyncGetVersion (dpyMcu::version_handler_function handler, dpyFirmware::Rfs rfs)
	Method which requests the firware version of the MCU. More...

void	getPowerInformation_U ()
	Method to stop receiving Power information coming from the service periodically.

boost::system::error_code	setI2CValue (unsigned char busid, unsigned char deviceid, std::list< unsigned char > address, std::list< unsigned char > values, dpyMcu::I2CValue &result)
	(Sync) Method which requests to set a I2C address pin with a value More...

boost::system::error_code	getI2CValue (unsigned char busid, unsigned char deviceid, std::list< unsigned char > address, int length, dpyMcu::I2CValue &result)
	(Sync) Method which requests one message with I2C information More...

void	asyncGetCanStatus (dpyMcu::can_status_handler_function handler)
	Method to get the current CAN Bus status. More...

Additional Inherited Members
Protected Attributes inherited from Mcu
boost::shared_ptr< McuClient >	mClient
	Reference to an Client Object.

Constructor & Destructor Documentation

McuPrivate ( std::string ip = "127.0.0.1" )

explicit

Parameters

ip	IP address to be binded to the App

Member Function Documentation

void asyncDisablePowerButton ( dpyMcu::set_power_button_state_handler_function handler )

Parameters

handler Handler to be called when a response comes from the service

void asyncEnablePowerButton ( dpyMcu::set_power_button_state_handler_function handler )

Parameters

handler Handler to be called when a response comes from the service

void asyncGetGpoDefValue	(	dpyMcu::gpio_handler_function	handler,
		std::uint32_t	gpo_number
	)

Parameters

handler	Handler to be called when a response comes from the service
gpo_number	Number of the GPO to get default value from

void asyncGetPowerButtonState ( dpyMcu::get_power_button_state_handler_function handler )

Parameters

handler Handler to be called when a response comes from the service

void asyncResetCanBusFilters ( dpyMcu::result_handler_function handler )

Parameters

handler Handler to be called when a response comes from the service

void asyncResetMcu ( dpyMcu::result_handler_function handler )

Parameters

handler Handler to be called when a response comes from the service

void asyncSetCanBusConfiguration	(	dpyMcu::result_handler_function	handler,
		dpyMcu::CANBusConfiguration	conf
	)

Parameters

handler	Handler to be called when a response comes from the service
conf	CAN bus configuration structure

void asyncSetCanBusFilters	(	dpyMcu::result_handler_function	handler,
		std::list< dpyMcu::CANBusFilter > &	filter_list
	)

Parameters

handler	Handler to be called when a response comes from the service
filter_list	List with CAN bus filter values

void asyncSetGpoDefValue	(	dpyMcu::gpio_handler_function	handler,
		std::uint32_t	gpo_number,
		bool	gpo_value
	)

Parameters

handler	Handler to be called when a response comes from the service
gpo_number	Number of the GPO to set default value
gpo_value	Value to set to GPO as default value

void asyncSetPowerStateConfig	(	dpyMcu::power_states_handler_function	handler,
		dpyMcu::PowerStates	state,
		std::uint32_t	flags
	)

TESTING : define this flag to fake/mock DPY API methods to be able to unit test classes which use DPY APIs.

Parameters

handler	Handler to be called when a response comes from the service
state	State to be set
flags	Event flags to be set to exit from the power state indicated

void asyncSetRtcDateConfig	(	dpyMcu::rtc_date_handler_function	handler,
		dpyMcu::DateConfig	configDate
	)

Parameters

handler	Handler to be called when a response comes from the service
configDate	Date configuration struct

void asyncSetSerialPortProtocol	(	dpyMcu::serialport_handler_function	handler,
		const std::string &	portid,
		dpyMcu::SerialPortProtocol	protocol
	)

Parameters

handler	Handler to be called when a response comes from the service
portid	Serial Port identifier
protocol	Serial Port protocol

void asyncSetTimersConfig	(	dpyMcu::timers_handler_function	handler,
		std::uint32_t	standby_min,
		std::uint32_t	halt_min
	)

Parameters

handler	Handler to be called when a response comes from the service
standby_min	Minutes to Standby Timer
halt_min	Minutes to Halt Timer

void asyncTestMisc ( dpyMcu::test_misc_handler_function handler )

Parameters

handler Handler to be called when a response comes from the service

boost::system::error_code resetCanBusFilters ( )

Returns: Error code

boost::system::error_code setCanBusConfiguration ( dpyMcu::CANBusConfiguration conf )

Parameters

conf	CAN bus configuration structure

Returns: Error code

boost::system::error_code setCanBusFilters ( std::list< dpyMcu::CANBusFilter > & filter_list )

Parameters

filter_list List with CAN bus filter values

Returns: Error code

boost::system::error_code setGpoDefValue	(	std::uint32_t	gpo_number,
		bool	gpo_value
	)

Parameters

gpo_number	Number of the GPO to set default value
gpo_value	Value to set to GPO as default value

Returns: Error code

boost::system::error_code setRtcDateConfig ( dpyMcu::DateConfig configDate )

Parameters

configDate Date configuration struct

Returns: error code

boost::system::error_code subscribe ( CANBusObserver * observer )

Parameters

observer observer to be added

Returns: error code

boost::system::error_code unsubscribe ( CANBusObserver * observer )

Parameters

observer observer to be removed

Returns: error code

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation