DashboardInterface Class Reference

#include <DashboardInterface.h>

Collaboration diagram for DashboardInterface:

Public Member Functions
	DashboardInterface (CANBufferType *msg_output_queue)
void	read (const CAN_message_t &can_msg)
CAN_message_t	write ()
void	tick10 (MCUInterface *mcu, int car_state, bool buzzer, bool drivetrain_error, TorqueLimit_e torque, float min_cell_voltage, AnalogConversion_s glv_voltage, int launch_state, ControllerMode_e dial_mode)
ControllerMode_e	getDialMode ()
TorqueLimit_e	getTorqueLimitMode ()
bool	safetySystemOK ()
bool	startButtonPressed ()
bool	specialButtonPressed ()
bool	torqueModeButtonPressed ()
bool	inverterResetButtonPressed ()
bool	launchControlButtonPressed ()
bool	torqueLoadingButtonPressed ()
bool	nightModeButtonPressed ()
bool	leftShifterButtonPressed ()
bool	rightShifterButtonPressed ()
bool	shutdownHAboveThreshold ()
void	soundBuzzer (bool s)
bool	checkBuzzer ()
void	setLED (DashLED_e led, LEDColors_e color)
ControllerMode_e	getDialMode ()
TorqueLimit_e	getTorqueLimitMode ()
bool	startButtonPressed ()
bool	checkBuzzer ()

Public Attributes
bool	buzzer = false
bool	start_button_status_

Private Member Functions
void	update_torque_mode_ (bool button_pressed)

Private Attributes
CANBufferType *	msg_queue_
DashComponentInterface_s	_data
bool	prev_button_pressed_state_

Detailed Description

Definition at line 82 of file DashboardInterface.h.

Constructor & Destructor Documentation

DashboardInterface()

DashboardInterface::DashboardInterface ( CANBufferType *  msg_output_queue )

inline

Constructor for new DashboardInterface, All that it is inited with is the pointer to the telem circular buffer that is used to write new messages

Parameters

msg_output_queue

Pointer to the telem CAN circular buffer

Definition at line 99 of file DashboardInterface.h.

    {
        _data.torque_limit_mode = TorqueLimit_e::TCMUX_FULL_TORQUE;
        prev_button_pressed_state_ = false;
        msg_queue_ = msg_output_queue;
    };

Member Function Documentation

checkBuzzer() [1/2]

bool DashboardInterface::checkBuzzer

(

)

Definition at line 160 of file DashboardInterface.cpp.

{ return _data.buzzer_state; }

checkBuzzer() [2/2]

bool DashboardInterface::checkBuzzer ( )

inline

Definition at line 41 of file DashboardInterface.h.

{ return buzzer; };

getDialMode() [1/2]

ControllerMode_e DashboardInterface::getDialMode

(

)

getter for the dashboard's current dial position (drive profile)

Returns

returns a ControllerMode_e enum with the current dial position

Definition at line 145 of file DashboardInterface.cpp.

{ return _data.dial_mode; }

getDialMode() [2/2]

ControllerMode_e DashboardInterface::getDialMode ( )

inline

Definition at line 38 of file DashboardInterface.h.

{return {};}

getTorqueLimitMode() [1/2]

TorqueLimit_e DashboardInterface::getTorqueLimitMode

(

)

Definition at line 146 of file DashboardInterface.cpp.

{return _data.torque_limit_mode; }

getTorqueLimitMode() [2/2]

TorqueLimit_e DashboardInterface::getTorqueLimitMode ( )

inline

Definition at line 39 of file DashboardInterface.h.

{return {};}

inverterResetButtonPressed()

bool DashboardInterface::inverterResetButtonPressed

(

)

Definition at line 150 of file DashboardInterface.cpp.

{ return _data.button.mc_cycle; }

launchControlButtonPressed()

bool DashboardInterface::launchControlButtonPressed

(

)

Definition at line 151 of file DashboardInterface.cpp.

{ return _data.button.launch_ctrl; }

leftShifterButtonPressed()

bool DashboardInterface::leftShifterButtonPressed

(

)

Definition at line 153 of file DashboardInterface.cpp.

{ return _data.button.left_shifter; }

nightModeButtonPressed()

bool DashboardInterface::nightModeButtonPressed

(

)

Definition at line 152 of file DashboardInterface.cpp.

{ return _data.button.led_dimmer; }

read()

void DashboardInterface::read

(

const CAN_message_t &

can_msg

)

read function will take in a reference to a new CAN message, unpack it, and will store all of the information into the DashComponentInterface for later access

Parameters

can_msg

is the reference to a new CAN message CAN_message_t

Definition at line 3 of file DashboardInterface.cpp.

{
 
    DASHBOARD_STATE_t dash_state;
    Unpack_DASHBOARD_STATE_hytech(&dash_state, can_msg.buf, can_msg.len);
 
    _data.dial_mode = static_cast<ControllerMode_e>(dash_state.dial_state);
 
    _data.ssok = dash_state.ssok_above_threshold;
    _data.shutdown = dash_state.shutdown_h_above_threshold;
 
    _data.button.start = dash_state.start_button;
    _data.button.mark = dash_state.mark_button;
    _data.button.mode = dash_state.mode_button;
    _data.button.mc_cycle = dash_state.motor_controller_cycle_button;
    _data.button.launch_ctrl = dash_state.launch_ctrl_button;
    _data.button.torque_mode = dash_state.torque_mode_button;
    _data.button.led_dimmer = dash_state.led_dimmer_button;
    _data.button.left_shifter = dash_state.left_shifter_button;
    _data.button.right_shifter = dash_state.right_shifter_button;
 
    _data.buzzer_state = dash_state.drive_buzzer;
 
    update_torque_mode_(_data.button.torque_mode);
}

rightShifterButtonPressed()

bool DashboardInterface::rightShifterButtonPressed

(

)

Definition at line 154 of file DashboardInterface.cpp.

{ return _data.button.right_shifter; }

safetySystemOK()

bool DashboardInterface::safetySystemOK

(

)

Definition at line 156 of file DashboardInterface.cpp.

{ return _data.ssok; }

setLED()

void DashboardInterface::setLED	(	DashLED_e	led,
		LEDColors_e	color
	)

setter for the dash LEDs

Parameters

led	DashLED_e enum that corresponds to the LED's value in the LED array
color	LEDColors_e enum that corresponds to the color/state of the set LED

Definition at line 78 of file DashboardInterface.cpp.

{
 
    _data.LED[static_cast<uint8_t>(led)] = static_cast<uint8_t>(color);
}

shutdownHAboveThreshold()

bool DashboardInterface::shutdownHAboveThreshold

(

)

Definition at line 157 of file DashboardInterface.cpp.

{ return _data.shutdown; }

soundBuzzer()

void DashboardInterface::soundBuzzer

(

bool

s

)

Definition at line 159 of file DashboardInterface.cpp.

{ _data.buzzer_cmd = state; }

specialButtonPressed()

bool DashboardInterface::specialButtonPressed

(

)

Definition at line 148 of file DashboardInterface.cpp.

{ return _data.button.mark; }

startButtonPressed() [1/2]

bool DashboardInterface::startButtonPressed

(

)

Definition at line 147 of file DashboardInterface.cpp.

{ return _data.button.start; }

startButtonPressed() [2/2]

bool DashboardInterface::startButtonPressed ( )

inline

Definition at line 40 of file DashboardInterface.h.

{ return  start_button_status_; };

tick10()

void DashboardInterface::tick10	(	MCUInterface *	mcu,
		int	car_state,
		bool	buzzer,
		bool	drivetrain_error,
		TorqueLimit_e	torque,
		float	min_cell_voltage,
		AnalogConversion_s	glv_voltage,
		int	launch_state,
		ControllerMode_e	dial_mode
	)

Definition at line 84 of file DashboardInterface.cpp.

{
 
    // TODO unfuck this
    _data.cur_dial_mode = dial_mode;
    soundBuzzer(buzzer);
 
    setLED(DashLED_e::AMS_LED, mcu->bms_ok_is_high() ? LEDColors_e::ON : LEDColors_e::RED);
    setLED(DashLED_e::IMD_LED, mcu->imd_ok_is_high() ? LEDColors_e::ON : LEDColors_e::RED);
    setLED(DashLED_e::BOTS_LED, mcu->get_bots_ok() ? LEDColors_e::ON : LEDColors_e::RED);
    setLED(DashLED_e::START_LED, car_state == int(MCU_STATE::READY_TO_DRIVE) ? LEDColors_e::ON : LEDColors_e::RED);
    setLED(DashLED_e::MC_ERROR_LED, !drivetrain_error ? LEDColors_e::ON : LEDColors_e::RED);
    setLED(DashLED_e::COCKPIT_BRB_LED, mcu->brb_ok_is_high() ? LEDColors_e::ON : LEDColors_e::RED);
 
    switch (launch_state)
    {
    case 1:
        setLED(DashLED_e::LAUNCH_CONTROL_LED, LEDColors_e::RED);
        break;
    case 2:
        setLED(DashLED_e::LAUNCH_CONTROL_LED, LEDColors_e::YELLOW);
        break;
    case 3:
        setLED(DashLED_e::LAUNCH_CONTROL_LED, LEDColors_e::ON);
        break;
    default:
        setLED(DashLED_e::LAUNCH_CONTROL_LED, LEDColors_e::OFF);
        break;
    }
 
    switch (torque)
    {
    case TorqueLimit_e::TCMUX_LOW_TORQUE:
        setLED(DashLED_e::MODE_LED, LEDColors_e::OFF);
        break;
    case TorqueLimit_e::TCMUX_MID_TORQUE:
        setLED(DashLED_e::MODE_LED, LEDColors_e::YELLOW);
        break;
    case TorqueLimit_e::TCMUX_FULL_TORQUE:
        setLED(DashLED_e::MODE_LED, LEDColors_e::ON);
        break;
    default:
        setLED(DashLED_e::MODE_LED, LEDColors_e::RED);
        break;
    }
 
    uint16_t scaled_cell_voltage = (uint16_t)map((uint32_t)(min_cell_voltage * 1000), 3300, 4200, 0, 255);          // scale voltage
    _data.LED[static_cast<int>(DashLED_e::CRIT_CHARGE_LED)] = std::max(0, std::min((int)scaled_cell_voltage, 255)); // clamp voltage
    // _data.LED[DashLED_e::GLV_LED] = (uint8_t)map(glv_voltage.raw)
 
    write();
}

torqueLoadingButtonPressed()

bool DashboardInterface::torqueLoadingButtonPressed

(

)

torqueModeButtonPressed()

bool DashboardInterface::torqueModeButtonPressed

(

)

Definition at line 149 of file DashboardInterface.cpp.

{ return _data.button.torque_mode; }

update_torque_mode_()

void DashboardInterface::update_torque_mode_ ( bool  button_pressed )

private

Definition at line 30 of file DashboardInterface.cpp.

{
    // detect high-to-low transition
    if (prev_button_pressed_state_ == true && button_pressed == false)
    {
        
        _data.torque_limit_mode = static_cast<TorqueLimit_e>((static_cast<int>(_data.torque_limit_mode) + 1) % (static_cast<int>(TorqueLimit_e::TCMUX_NUM_TORQUE_LIMITS)));
    }
    prev_button_pressed_state_ = button_pressed;
}

write()

CAN_message_t DashboardInterface::write

(

)

Definition at line 41 of file DashboardInterface.cpp.

{
 
    DASHBOARD_MCU_STATE_t dash_mcu_state;
    dash_mcu_state.drive_buzzer = _data.buzzer_cmd;
 
    dash_mcu_state.dial_state = static_cast<uint8_t>(_data.cur_dial_mode);
 
    // TODO: use logic as to not write data for LEDs that have not changed
    dash_mcu_state.launch_control_led = _data.LED[static_cast<int>(DashLED_e::LAUNCH_CONTROL_LED)];
    dash_mcu_state.mode_led = _data.LED[static_cast<int>(DashLED_e::MODE_LED)];
    dash_mcu_state.mechanical_brake_led = _data.LED[static_cast<int>(DashLED_e::MECH_BRAKE_LED)];
    dash_mcu_state.cockpit_brb_led = _data.LED[static_cast<int>(DashLED_e::COCKPIT_BRB_LED)];
    dash_mcu_state.inertia_status_led = _data.LED[static_cast<int>(DashLED_e::INERTIA_LED)];
    dash_mcu_state.start_status_led = _data.LED[static_cast<int>(DashLED_e::START_LED)];
    dash_mcu_state.motor_controller_error_led = _data.LED[static_cast<int>(DashLED_e::MC_ERROR_LED)];
 
    dash_mcu_state.bots_led = _data.LED[static_cast<int>(DashLED_e::BOTS_LED)];
    dash_mcu_state.imd_led = _data.LED[static_cast<int>(DashLED_e::IMD_LED)];
    dash_mcu_state.ams_led = _data.LED[static_cast<int>(DashLED_e::AMS_LED)];
 
    dash_mcu_state.glv_led = _data.LED[static_cast<int>(DashLED_e::GLV_LED)];
    dash_mcu_state.pack_charge_led = _data.LED[static_cast<int>(DashLED_e::CRIT_CHARGE_LED)];
 
    CAN_message_t can_msg;
    auto id = Pack_DASHBOARD_MCU_STATE_hytech(&dash_mcu_state, can_msg.buf, &can_msg.len, (uint8_t *)&can_msg.flags.extended);
    can_msg.id = id;
    // this circular buffer implementation requires that you push your data in a array buffer
    // all this does is put the msg into a uint8_t buffer and pushes it onto the queue
    uint8_t buf[sizeof(CAN_message_t)] = {};
    memmove(buf, &can_msg, sizeof(CAN_message_t));
    msg_queue_->push_back(buf, sizeof(CAN_message_t));
 
    return can_msg;
}

Member Data Documentation

_data

DashComponentInterface_s DashboardInterface::_data

private

Definition at line 88 of file DashboardInterface.h.

buzzer

bool DashboardInterface::buzzer = false

Definition at line 36 of file DashboardInterface.h.

msg_queue_

CANBufferType* DashboardInterface::msg_queue_

private

Definition at line 86 of file DashboardInterface.h.

prev_button_pressed_state_

bool DashboardInterface::prev_button_pressed_state_

private

Definition at line 89 of file DashboardInterface.h.

start_button_status_

bool DashboardInterface::start_button_status_

Definition at line 37 of file DashboardInterface.h.

---

The documentation for this class was generated from the following files:

• lib/interfaces/include/DashboardInterface.h
• lib/mock_interfaces/DashboardInterface.h
• lib/interfaces/src/DashboardInterface.cpp