ws22_motor_can.h

#pragma once
 
/************************************************************************************************
 * @file   ws22_motor_can.h
 *
 * @brief  Header file for Wavesculptor 22 CAN interface
 *
 * @date   2025-04-23
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stdbool.h>
#include <stdint.h>
 
/* Inter-component Headers */
#include "status.h"
 
/* Intra-component Headers */
 
/* CAN Message Base Addresses */
#define WS22_CAN_BASE_CONTROL 0x500U 
#define WS22_CAN_BASE_STATUS 0x80U   
#define VEHICLE_RPM_TO_KPH 0.10367f
 
/* CAN Message IDs */
#define WS22_CAN_ID_DRIVE_CMD (WS22_CAN_BASE_CONTROL + 0x01U)
#define WS22_CAN_ID_STATUS_INFO (WS22_CAN_BASE_STATUS + 0x01U)
#define WS22_CAN_ID_BUS_MEASUREMENT (WS22_CAN_BASE_STATUS + 0x02U)
#define WS22_CAN_ID_VELOCITY_MEASUREMENT (WS22_CAN_BASE_STATUS + 0x03U)
#define WS22_CAN_ID_RESET (WS22_CAN_BASE_CONTROL + 0x03U)
#define WS22_CAN_ID_PHASE_CURRENT (WS22_CAN_BASE_STATUS + 0x04U)
#define WS22_CAN_ID_MOTOR_VOLTAGE (WS22_CAN_BASE_STATUS + 0x05U)
#define WS22_CAN_ID_MOTOR_CURRENT (WS22_CAN_BASE_STATUS + 0x06U)
#define WS22_CAN_ID_MOTOR_BACK_EMF (WS22_CAN_BASE_STATUS + 0x07U)
#define WS22_CAN_ID_RAIL_15V (WS22_CAN_BASE_STATUS + 0x08U)
#define WS22_CAN_ID_TEMPERATURE (WS22_CAN_BASE_STATUS + 0x0BU)
 
typedef struct {
  float current;  
  float velocity; 
} Ws22MotorControlData;
 
typedef struct {
  /* Status Information (0x401/0x81) */
  uint16_t error_flags;  
  uint16_t limit_flags;  
  uint16_t merged_flags; 
  /* Bus Measurements (0x402/0x82) */
  float bus_current; 
  float bus_voltage; 
  /* Velocity Measurements (0x403/0x83) */
  float vehicle_velocity_kph; 
  float motor_velocity;       
  /* Phase Currents (0x404/0x84) */
  float phase_b_current; 
  float phase_c_current; 
  /* Motor Voltages (0x405/0x85) */
  float voltage_d; 
  float voltage_q; 
  /* Motor Currents (0x406/0x86) */
  float current_d; 
  float current_q; 
  /* Motor Back EMF (0x407/0x87) */
  float back_emf_d; 
  float back_emf_q; 
  /* Power Rail (0x408/0x88) */
  float rail_15v_supply; 
  /* Temperature Measurements (0x40B/0x8B) */
  float heat_sink_temp; 
  float motor_temp;     
} Ws22MotorTelemetryData;
 
typedef struct {
  bool ws22_status_info_enabled;          
  bool ws22_bus_measurement_enabled;      
  bool ws22_velocity_measurement_enabled; 
  bool ws22_phase_current_enabled;        
  bool ws22_motor_voltage_enabled;        
  bool ws22_motor_current_enabled;        
  bool ws22_motor_back_emf_enabled;       
  bool ws22_rail_15v_enabled;             
  bool ws22_temperature_enabled;          
  bool ws22_drive_cmd_enabled;            
} Ws22MotorCanConfig;
 
typedef struct Ws22MotorCanStorage {
  Ws22MotorControlData control;     
  Ws22MotorTelemetryData telemetry; 
} Ws22MotorCanStorage;
 
StatusCode ws22_motor_can_init(Ws22MotorCanStorage *storage, Ws22MotorCanConfig *config);
 
StatusCode ws22_motor_can_set_current(float current);
 
StatusCode ws22_motor_can_set_velocity(float velocity);
 
StatusCode ws22_motor_can_process_rx(uint8_t *msg_data_u8, uint32_t msg_id_raw, uint8_t msg_dlc);
 
Ws22MotorControlData *ws22_motor_can_get_control_data(void);
 
Ws22MotorTelemetryData *ws22_motor_can_get_telemetry_data(void);