Midnight Sun Firmware
Loading...
Searching...
No Matches
GlobalEnums

Global Enum definition for sharing between projects. More...

Macros

#define BPS_FAULT_OVERVOLTAGE_MASK   (1U << BPS_FAULT_OVERVOLTAGE)
 BPS Overvoltage fault mask.
 
#define BPS_FAULT_UNBALANCE_MASK   (1U << BPS_FAULT_UNBALANCE)
 BPS Unbalanced fault mask.
 
#define BPS_FAULT_OVERTEMP_AMBIENT_MASK   (1U << BPS_FAULT_OVERTEMP_AMBIENT)
 BPS Ambient temperature fault mask.
 
#define BPS_FAULT_COMMS_LOSS_AFE_MASK   (1U << BPS_FAULT_COMMS_LOSS_AFE)
 BPS Communication lost with AFEs fault mask.
 
#define BPS_FAULT_COMMS_LOSS_CURR_SENSE_MASK   (1U << BPS_FAULT_COMMS_LOSS_CURR_SENSE)
 BPS Communication lost with current sense fault mask.
 
#define BPS_FAULT_OVERTEMP_CELL_MASK   (1U << BPS_FAULT_OVERTEMP_CELL)
 BPS Cell temperature fault mask.
 
#define BPS_FAULT_OVERCURRENT_MASK   (1U << BPS_FAULT_OVERCURRENT)
 BPS Overcurrent fault mask.
 
#define BPS_FAULT_UNDERVOLTAGE_MASK   (1U << BPS_FAULT_UNDERVOLTAGE)
 BPS Undervoltage fault mask.
 
#define BPS_FAULT_KILLSWITCH_MASK   (1U << BPS_FAULT_KILLSWITCH)
 BPS Killswitch fault mask.
 
#define BPS_FAULT_RELAY_CLOSE_FAILED_MASK   (1U << BPS_FAULT_RELAY_CLOSE_FAILED)
 BPS Relay failed to close fault mask.
 
#define BPS_FAULT_DISCONNECTED_MASK   (1U << BPS_FAULT_DISCONNECTED)
 BPS Disconnected fault mask.
 
#define BPS_FAULT_HIGH_PRIORITY_MASK   (1U << 15U)
 BPS High priority fault mask.
 
#define BPS_FAULT_LOW_PRIORITY_MASK   (1U << 14U)
 BPS Low priority fault mask.
 
#define STEERING_CC_INCREASE_MASK   (1U << EE_STEERING_CC_INCREASE_BIT)
 Increase cruise control speed mask.
 
#define STEERING_CC_DECREASE_MASK   (1U << EE_STEERING_CC_DECREASE_BIT)
 Decrease cruise control speed mask.
 
#define STEERING_CC_TOGGLE_MASK   (1U << EE_STEERING_CC_TOGGLE_BIT)
 Toggle cruise control mask.
 

Enumerations

enum  VehicleDriveState {
  VEHICLE_DRIVE_STATE_INVALID = 0 , VEHICLE_DRIVE_STATE_NEUTRAL , VEHICLE_DRIVE_STATE_DRIVE , VEHICLE_DRIVE_STATE_REVERSE ,
  VEHICLE_DRIVE_STATE_CRUISE , VEHICLE_DRIVE_STATE_BRAKE , VEHICLE_DRIVE_STATE_REGEN
}
 Vehicle drive states. More...
 
enum  VehiclePowerStates { VEHICLE_POWER_STATE_IDLE , VEHICLE_POWER_STATE_DRIVE , VEHICLE_POWER_STATE_CHARGE , VEHICLE_POWER_STATE_FAULT }
 Vehicle power states. More...
 
enum  BpsFault {
  BPS_FAULT_OVERVOLTAGE , BPS_FAULT_UNBALANCE , BPS_FAULT_OVERTEMP_AMBIENT , BPS_FAULT_COMMS_LOSS_AFE ,
  BPS_FAULT_COMMS_LOSS_CURR_SENSE , BPS_FAULT_OVERTEMP_CELL , BPS_FAULT_OVERCURRENT , BPS_FAULT_UNDERVOLTAGE ,
  BPS_FAULT_KILLSWITCH , BPS_FAULT_RELAY_CLOSE_FAILED , BPS_FAULT_DISCONNECTED , NUM_BPS_FAULTS
}
 Battery fault definitions. More...
 
enum  SteeringLightState {
  STEERING_LIGHTS_OFF_STATE , STEERING_LIGHTS_LEFT_STATE , STEERING_LIGHTS_RIGHT_STATE , STEERING_LIGHTS_HAZARD_STATE ,
  NUM_STEERING_LIGHTS
}
 Steering lights definitions. More...
 
enum  SteeringCruiseControl { STEERING_CRUISE_CONTROL_DECREASE_BIT = 0 , STEERING_CRUISE_CONTROL_INCREASE_BIT , STEERING_CRUISE_CONTROL_TOGGLE_BIT }
 Steering cruise control definitions. More...
 
enum  PDPowerState { EE_POWER_OFF_STATE , EE_POWER_PRECHARGE_STATE , EE_POWER_DRIVE_STATE , EE_POWER_FAULT_STATE }
 Power distribution power state definitions. More...
 

Detailed Description

Global Enum definition for sharing between projects.

Enumeration Type Documentation

◆ BpsFault

enum BpsFault

Battery fault definitions.

Enumerator
BPS_FAULT_OVERVOLTAGE 

BPS Overvoltage fault

BPS_FAULT_UNBALANCE 

BPS Unbalanced fault

BPS_FAULT_OVERTEMP_AMBIENT 

BPS Ambient temperature fault

BPS_FAULT_COMMS_LOSS_AFE 

BPS Communication lost with AFEs fault

BPS_FAULT_COMMS_LOSS_CURR_SENSE 

BPS Communication lost with current sense fault

BPS_FAULT_OVERTEMP_CELL 

BPS Cell temperature fault

BPS_FAULT_OVERCURRENT 

BPS Overcurrent fault

BPS_FAULT_UNDERVOLTAGE 

BPS Undervoltage fault

BPS_FAULT_KILLSWITCH 

BPS Killswitch fault

BPS_FAULT_RELAY_CLOSE_FAILED 

BPS Relay failed to close fault

BPS_FAULT_DISCONNECTED 

BPS Disconnected fault

◆ PDPowerState

Power distribution power state definitions.

Enumerator
EE_POWER_OFF_STATE 

Power distribution off state

EE_POWER_PRECHARGE_STATE 

Power distribution precharge state

EE_POWER_DRIVE_STATE 

Power distribution drive state

EE_POWER_FAULT_STATE 

Power distribution fault state

◆ SteeringCruiseControl

Steering cruise control definitions.

Enumerator
STEERING_CRUISE_CONTROL_DECREASE_BIT 

Decrease cruise control speed

STEERING_CRUISE_CONTROL_INCREASE_BIT 

Increase cruise control speed

STEERING_CRUISE_CONTROL_TOGGLE_BIT 

Toggle cruise control

◆ SteeringLightState

Steering lights definitions.

Enumerator
STEERING_LIGHTS_OFF_STATE 

Steering lights off turn

STEERING_LIGHTS_LEFT_STATE 

Steering light left turn

STEERING_LIGHTS_RIGHT_STATE 

Steering light right turn

STEERING_LIGHTS_HAZARD_STATE 

Steering light hazard state

NUM_STEERING_LIGHTS 

Number of steering light states

◆ VehicleDriveState

Vehicle drive states.

Enumerator
VEHICLE_DRIVE_STATE_INVALID 

Wrong State

VEHICLE_DRIVE_STATE_NEUTRAL 

Car Not Actively Moving in Neutral

VEHICLE_DRIVE_STATE_DRIVE 

Car Drive Forward

VEHICLE_DRIVE_STATE_REVERSE 

Car Drive Reverse

VEHICLE_DRIVE_STATE_CRUISE 

Car Cruise Constant Velocity

VEHICLE_DRIVE_STATE_BRAKE 

Car Brake

VEHICLE_DRIVE_STATE_REGEN 

Car Brake With Regen

◆ VehiclePowerStates

Vehicle power states.

Enumerator
VEHICLE_POWER_STATE_IDLE 

Ready but not driving or charging, cars in neutral

VEHICLE_POWER_STATE_DRIVE 

Driving: motor relays closed, LV enabled

VEHICLE_POWER_STATE_CHARGE 

Charging: charger detected, motor relay may be required

VEHICLE_POWER_STATE_FAULT 

Faulted: relays open, latched until reset