VehicleIO Driver Interface

Detailed Description

Defines the VehicleIO Driver module for accessing a custom VehicleIO backend.

Functions
dwStatus	_dwVehicleIODriver_clearFaults (dwSensorHandle_t sensor, const dwVehicleIOState *state)
	Clear faults in current vehicle state. More...
dwStatus	_dwVehicleIODriver_consume (const dwCANMessage *msg, dwVehicleIOState *state)
	Consume a received CAN message and update the vehicle state. More...
dwStatus	_dwVehicleIODriver_initialize ()
	Initializes the VehicleIO Driver. More...
dwStatus	_dwVehicleIODriver_release ()
	Releases the VehicleIO Driver. More...
dwStatus	_dwVehicleIODriver_reset ()
	Reset driver to default state. More...
dwStatus	_dwVehicleIODriver_sendCommand (const dwVehicleIOCommand *cmd, dwSensorHandle_t sensor)
	Send a vehicle command to the given CAN sensor. More...
dwStatus	_dwVehicleIODriver_sendMiscCommand (const dwVehicleIOMiscCommand *cmd, dwSensorHandle_t sensor)
	Send misc vehicle command to the given CAN sensor. More...
dwStatus	_dwVehicleIODriver_setDrivingMode (const dwVehicleIODrivingMode mode)
	Set driving mode. More...

Function Documentation

_dwVehicleIODriver_clearFaults()

dwStatus _dwVehicleIODriver_clearFaults	(	dwSensorHandle_t	sensor,
		const dwVehicleIOState *	state
	)

Clear faults in current vehicle state.

Parameters

[in]	sensor	CAN sensor to send CAN messages.
[in]	state	Structure specifying overrides or faults.

Returns

DW_FAILURE, DW_SUCCESS

_dwVehicleIODriver_consume()

dwStatus _dwVehicleIODriver_consume	(	const dwCANMessage *	msg,
		dwVehicleIOState *	state
	)

Consume a received CAN message and update the vehicle state.

Parameters

[in]	msg	CAN message to be consumed.
[in]	state	Structure updated with data from CAN message.

Returns

DW_FAILURE, DW_SUCCESS

_dwVehicleIODriver_initialize()

dwStatus _dwVehicleIODriver_initialize

(

)

Initializes the VehicleIO Driver.

Returns

DW_FAILURE, DW_SUCCESS

_dwVehicleIODriver_release()

dwStatus _dwVehicleIODriver_release

(

)

Releases the VehicleIO Driver.

Returns

DW_FAILURE, DW_SUCCESS

_dwVehicleIODriver_reset()

dwStatus _dwVehicleIODriver_reset

(

)

Reset driver to default state.

Returns

DW_FAILURE, DW_SUCCESS

Note

This would not perform any changes regarding current vehicle state.

_dwVehicleIODriver_sendCommand()

dwStatus _dwVehicleIODriver_sendCommand	(	const dwVehicleIOCommand *	cmd,
		dwSensorHandle_t	sensor
	)

Send a vehicle command to the given CAN sensor.

Parameters

[in]	cmd	Command with parameters to be sent.
[in]	sensor	CAN sensor to send CAN messages.

Returns

DW_FAILURE, DW_SUCCESS

_dwVehicleIODriver_sendMiscCommand()

dwStatus _dwVehicleIODriver_sendMiscCommand	(	const dwVehicleIOMiscCommand *	cmd,
		dwSensorHandle_t	sensor
	)

Send misc vehicle command to the given CAN sensor.

Parameters

[in]	cmd	Command with parameters to be sent.
[in]	sensor	CAN sensor to send CAN messages.

Returns

DW_FAILURE, DW_SUCCESS

_dwVehicleIODriver_setDrivingMode()

dwStatus _dwVehicleIODriver_setDrivingMode

(

const dwVehicleIODrivingMode

mode

)

Set driving mode.

Parameters

[in]

mode

specifies the mode of driving.

Returns

DW_NOT_SUPPORTED - if the mode is not supported. DW_SUCCESS - if the new mode has been accepted.