Mcu Interface Reference

Mcu.

Inheritance diagram for Mcu:

Public Member Functions
void	setI2CValues (Byte bus, Byte device, Byte address, List< Byte > values) throws McuNotAvailableException, McuLowLevelException
List< Byte >	getI2CValues (Byte bus, Byte device, Byte address, int lenght) throws McuNotAvailableException, McuLowLevelException
Boolean	getGpioValue (int gpioNumber) throws McuNotAvailableException, McuLowLevelException
void	setGpioValue (int gpioNumber, Boolean value) throws McuNotAvailableException, McuLowLevelException
ConfigLeds	getLedsConfig () throws McuNotAvailableException, McuLowLevelException
void	setLedsConfig (LedsColor color, int period, int duty_cycle) throws McuNotAvailableException, McuLowLevelException
CanBusStatus	getCanStatus () throws McuNotAvailableException, McuLowLevelException
McuPowerInformation	getPowerInformation () throws McuNotAvailableException, McuLowLevelException
ConfigBatteryProtection	getBatteryProtectionConfig () throws McuNotAvailableException, McuLowLevelException
void	setBatteryProtectionConfig (float idle_voltage, float voltage_percentage_threshold, float hysteresis_percentage, int grace_period_minutes) throws McuNotAvailableException, McuLowLevelException
List< ConfigGUID >	getConfigGUID () throws McuNotAvailableException, McuLowLevelException
McuFirmwareInfo	getCurrentMcuFirmwareInfo () throws McuNotAvailableException, McuLowLevelException
McuFirmwareInfo	getAlternativeMcuFirmwareInfo () throws McuNotAvailableException, McuLowLevelException
Public Member Functions inherited from Subject< T extends Observer< U, U extends Event >
void	subscribe (T observer) throws CannotSubscribeException
void	unSubscribe (T observer) throws ObserverNotSubscribedException

Member Function Documentation

getAlternativeMcuFirmwareInfo()

McuFirmwareInfo getAlternativeMcuFirmwareInfo

(

)

throws McuNotAvailableException, McuLowLevelException

Get Alternative Mcu Firmware Info

Exceptions

McuNotAvailableException
McuLowLevelException

Returns

Mcu Firmware Info

getBatteryProtectionConfig()

ConfigBatteryProtection getBatteryProtectionConfig

(

)

throws McuNotAvailableException, McuLowLevelException

Get Battery Protection configuration

Exceptions

McuNotAvailableException
McuLowLevelException

Returns

Battery Protection configuration obtained

getCanStatus()

CanBusStatus getCanStatus

(

)

throws McuNotAvailableException, McuLowLevelException

Get CAN bus status

Exceptions

McuNotAvailableException
McuLowLevelException

Returns

Current status of CAN bus

getConfigGUID()

List<ConfigGUID> getConfigGUID

(

)

throws McuNotAvailableException, McuLowLevelException

Get Battery Protection configuration

Exceptions

McuNotAvailableException
McuLowLevelException

Returns

List of ConfigGUID

getCurrentMcuFirmwareInfo()

McuFirmwareInfo getCurrentMcuFirmwareInfo

(

)

throws McuNotAvailableException, McuLowLevelException

Get Current Mcu Firmware Info

Exceptions

McuNotAvailableException
McuLowLevelException

Returns

Mcu Firmware Info

getGpioValue()

Boolean getGpioValue

(

int

gpioNumber

)

throws McuNotAvailableException, McuLowLevelException

Get value for a specific GPIO number

Parameters

gpioNumber

gpio number from which the value wants to be obtained

Exceptions

McuNotAvailableException
McuLowLevelException

Returns

GPIO value (Possible values are 1 --> True or 0 --> False)

getI2CValues()

List<Byte> getI2CValues	(	Byte	bus,
		Byte	device,
		Byte	address,
		int	lenght
	)		throws McuNotAvailableException, McuLowLevelException

Gets values from an i2c device

Parameters

bus	bis id
device	device id
address	memory address
lenght	number of bytes to read

Exceptions

McuNotAvailableException
McuLowLevelException

Returns

list of bytes

getLedsConfig()

ConfigLeds getLedsConfig

(

)

throws McuNotAvailableException, McuLowLevelException

Get LEDs configuration

Exceptions

McuNotAvailableException
McuLowLevelException

Returns

Leds configuration obtained

getPowerInformation()

McuPowerInformation getPowerInformation

(

)

throws McuNotAvailableException, McuLowLevelException

Get MCU Power related information

Returns

McuPowerInformation class containing MCU Power information

Exceptions

McuNotAvailableException
McuLowLevelException

setBatteryProtectionConfig()

void setBatteryProtectionConfig	(	float	idle_voltage,
		float	voltage_percentage_threshold,
		float	hysteresis_percentage,
		int	grace_period_minutes
	)		throws McuNotAvailableException, McuLowLevelException

Request to change the Battery Protection configuration

Exceptions

McuNotAvailableException
McuLowLevelException

Parameters

idle_voltage
voltage_percentage_threshold
hysteresis_percentage
grace_period_minutes

setGpioValue()

void setGpioValue	(	int	gpioNumber,
		Boolean	value
	)		throws McuNotAvailableException, McuLowLevelException

Set value for a specific GPIO number

Parameters

gpioNumber	GPIO number to be set
value	GPIO value to be set (Possible values are 1 --> True or 0 --> False)

Exceptions

McuNotAvailableException
McuLowLevelException

setI2CValues()

void setI2CValues	(	Byte	bus,
		Byte	device,
		Byte	address,
		List< Byte >	values
	)		throws McuNotAvailableException, McuLowLevelException

Set values in i2c device

Parameters

bus	bis id
device	device id
address	memory address
values	values to set as a list of bytes

Exceptions

McuNotAvailableException
McuLowLevelException

setLedsConfig()

void setLedsConfig	(	LedsColor	color,
		int	period,
		int	duty_cycle
	)		throws McuNotAvailableException, McuLowLevelException

Request to change the LED color state

Exceptions

McuNotAvailableException
McuLowLevelException

Parameters

color	to be set
period	periodic time to be set in seconds (range: 0 - 40)
duty_cycle	duty cycle to be set in percentage (range: 1 - 100)