CanandcoderStatus.h

// Copyright (c) Redux Robotics and other contributors.
// This is open source and can be modified and shared under the 3-clause BSD license.
 
#pragma once
#include <units/temperature.h>
#include "redux/sensors/canandcoder/CanandcoderFaults.h"
 
namespace redux::sensors::canandcoder {
 
/**
 * Struct class representing a Canandcoder's status.
*/
struct CanandcoderStatus {
  /**
   * Constructor for CanandcoderStatus
   * @param activeFaultsRaw raw uint8_t field
   * @param stickyFaultsRaw raw uint8_t field
   * @param faultsValid whether the faults fields have valid adata
   * @param temp MCU temp
   * @param magnetInRange whether the encoder magnet is in range
  */
  constexpr CanandcoderStatus(uint8_t activeFaultsRaw, uint8_t stickyFaultsRaw, bool faultsValid, units::celsius_t temp, bool magnetInRange): \
    activeFaults{activeFaultsRaw, faultsValid}, stickyFaults{stickyFaultsRaw, faultsValid}, temperature{temp}, magnetInRange{magnetInRange} {};
  public:
    /** Active faults. */
    CanandcoderFaults activeFaults;
    /** Sticky faults. */
    CanandcoderFaults stickyFaults;
    /** Encoder MCU temperature (celsius). */
    units::celsius_t temperature;
    /** Whether the magnet is in range. */
    bool magnetInRange;
};
}