Merge pull request EmbeddedRPC#125 from VERO-Biotech/GDS4-1764-adaptive-sensor

Gds4 1764 adaptive sensor

Author: BriceAaron

.cproject

@@ -157,6 +157,8 @@
 									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/${ProjName}/Bench/eRPC/InjectionControl}&quot;"/>
 									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/${ProjName}/Bench/eRPC/TaskScheduler}&quot;"/>
 									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/${ProjName}/Bench/eRPC/Diagnostics}&quot;"/>
+									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/${ProjName}/Bench/eRPC/AdaptiveSensor}&quot;"/>
+									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/${ProjName}/Bench/AdaptiveSensor/Inc}&quot;"/>
 								</option>
 								<option IS_BUILTIN_EMPTY="false" IS_VALUE_EMPTY="false" id="com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.cpp.compiler.option.definedsymbols.1078652032" name="Define symbols (-D)" superClass="com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.cpp.compiler.option.definedsymbols" useByScannerDiscovery="false" valueType="definedSymbols">
 									<listOptionValue builtIn="false" value="DEBUG"/>

Bench/AdaptiveSensor/Inc/AdaptiveSensor.hpp

@@ -0,0 +1,30 @@
+#ifndef ADAPTIVESENSOR_HPP_
+#define ADAPTIVESENSOR_HPP_
+
+#include <cstdint>
+
+#define ADAPT_SW_VER_STRLEN				9  // xxx.yyya
+#define ADAPT_HW_VER_STRLEN				8  // xxx.yyy
+#define ADAPT_ART_STRLEN				12 // 1-aabbcc-dd
+
+/**
+ * @brief Abstract base class for adaptive sensor
+ */
+class AdaptiveSensor {
+public:
+	virtual ~AdaptiveSensor() = default;
+
+	virtual void init() = 0;
+
+	virtual int8_t boardReset() = 0;
+	virtual int8_t hardReset() = 0;
+	virtual int8_t softReset() = 0;
+
+	virtual int8_t getFlowMeasurement(int32_t *value) = 0;
+
+	virtual int8_t getSwVersion(char swVersion[ADAPT_SW_VER_STRLEN]) = 0;
+	virtual int8_t getHwVersion(char hwVersion[ADAPT_HW_VER_STRLEN]) = 0;
+	virtual int8_t getArticle(char article[ADAPT_ART_STRLEN]) = 0;
+};
+
+#endif /* ADAPTIVESENSOR_HPP_ */

Bench/AdaptiveSensor/Inc/AdaptiveSensorControl.hpp

@@ -0,0 +1,24 @@
+#ifndef ADAPTIVESENSORCONTROL_H
+#define ADAPTIVESENSORCONTROL_H
+
+#include "AdaptiveSensor.hpp"
+#include "AdaptiveSensorHw.hpp"
+#include "AdaptiveSensorSim.hpp"
+
+#include <memory>
+
+class AdaptiveSensorControl
+{
+public:
+    AdaptiveSensorControl();
+    void init();
+    void serviceTask();
+
+	AdaptiveSensor *getSensor() { return m_sensor; };
+
+private:
+    std::unique_ptr<AdaptiveSensorSim> m_sensorSim;
+    std::unique_ptr<AdaptiveSensorHw> m_sensorHw;
+	AdaptiveSensor *m_sensor;
+};
+#endif //ADAPTIVESENSORCONTROL_H

Bench/AdaptiveSensor/Inc/AdaptiveSensorHw.hpp

@@ -0,0 +1,134 @@
+#ifndef ADAPTIVESENSORHW_HPP_
+#define ADAPTIVESENSORHW_HPP_
+
+#include "AdaptiveSensor.hpp"
+#include "GpioDriver.hpp"
+
+#include <vector>
+
+#include "usart.h"
+
+#define ADAPT_ADDRESS					1
+
+#define ADAPT_CMD_GET_SW_VERSION		1
+#define ADAPT_CMD_GET_HW_VERSION		2
+#define ADAPT_CMD_GET_ARTICLE			10
+#define ADAPT_CMD_BOARD_RESET			11
+#define ADAPT_CMD_HARD_RESET			12
+#define ADAPT_CMD_SOFT_RESET			13
+#define ADAPT_CMD_GET_FLOW_MEAS			16
+
+// pre-computed CRC8 crcs for the commands
+#define ADAPT_CRC_GET_SW_VERSION		0xB2
+#define ADAPT_CRC_GET_HW_VERSION		0x9F
+#define ADAPT_CRC_GET_ARTICLE			0xA8
+#define ADAPT_CRC_BOARD_RESET			0x5C
+#define ADAPT_CRC_HARD_RESET			0xF2
+#define ADAPT_CRC_SOFT_RESET			0x06
+#define ADAPT_CRC_GET_FLOW_MEAS			0x28
+
+// timeout in milliseconds when expecting a response from adaptive sensor
+#define ADAPT_TIMEOUT					100
+
+// structs are packed differently in gcc vs MSVC.
+// MSVC could be used to compile this for unit tests.
+#ifdef __GNUC__
+#define PACKED __attribute__((packed))
+#else
+#define PACKED
+#pragma pack(push, 1)
+#endif
+
+struct adapt_comm_cmd {
+	uint8_t address; // 0x01
+	uint8_t cmd; // per above
+	uint8_t len; // 0
+	uint8_t crc; // crc8
+} PACKED;
+
+#ifdef _MSC_VER
+#pragma pack(pop)
+#endif
+
+/**
+ * @brief Hardware implementation of the AdaptiveSensor using STM32 HAL.
+ */
+class AdaptiveSensorHw : public AdaptiveSensor
+{   
+	public:
+		/**
+		 * @brief Constructor for AdaptiveSensorHw.
+		 * @param uart Pointer to the uart.
+		 * @param dePort GPIO port for RS485 drive enable.
+		 * @param dePin GPIO pin for RS485 drive enable.
+		 *
+		 * Because the schematic used the wrong pin for UART_DE, the DE pin needs to
+		 * handled manually instead of by the hal uart driver.  Brkjing DE high to send
+		 * data and low to receive response.
+		 */
+		AdaptiveSensorHw(UART_HandleTypeDef* uart, GPIO_TypeDef* dePort, uint16_t dePin);
+
+		/**
+		 * @brief Initialize the hardware adaptive sensor
+		 */
+		void init() override;
+
+		/**
+		 * @brief Do a reset of the adaptive sensor board.  Probably want this one
+		 * @return 0 on success, <0 on communication error, >0 on error returned from sensor
+		 */
+		int8_t boardReset() override;
+
+		/**
+		 * @brief Do a hard reset of the sensor.
+		 * @return 0 on success, <0 on communication error, >0 on error returned from sensor
+		 */
+		int8_t hardReset() override;
+
+		/**
+		 * @brief Do a soft reset of the sensor.
+		 * @return 0 on success, <0 on communication error, >0 on error returned from sensor
+		 */
+		int8_t softReset() override;
+
+		/**
+		 * @brief Get the current flow getFlowMeasurement
+		 * @param[out] value Measured flow value in mSlm^2 (milli-standard-liters per minute)
+		 *                   Divide by 1000 to get slpm
+		 * @return 0 on success, <0 on communication error, >0 on error returned from sensor
+		 */
+		int8_t getFlowMeasurement(int32_t *value) override;
+
+		/**
+		 * @brief Get the software version of the adaptive sensor
+		 * @param[out] swVersion max 9 bytes xxx.yyyc (ex: "10.32a"
+		 * @return 0 on success, <0 on communication error, >0 on error returned from sensor
+		 */
+		int8_t getSwVersion(char swVersion[ADAPT_SW_VER_STRLEN]) override;
+
+		/**
+		 * @brief Get the hardware version of the adaptive sensor
+		 * @param[out] swVersion max 9 bytes xxx.yyyc (ex: "10.32a"
+		 * @return 0 on success, <0 on communication error, >0 on error returned from sensor
+		 */
+		int8_t getHwVersion(char hwVersion[ADAPT_HW_VER_STRLEN]) override;
+
+		/**
+		 * @brief Get the "Sensirion article id" of the adaptive sensor for example 1-101053-01
+		 * @param[out] article max 12 bytes
+		 * @return 0 on success, <0 on communication error, >0 on error returned from sensor
+		 */
+		int8_t getArticle(char article[ADAPT_ART_STRLEN]) override;
+
+	private:
+		UART_HandleTypeDef* m_uart;
+		GpioDriver m_driveEnable;
+
+		int8_t sendCmd(const struct adapt_comm_cmd& cmd);
+		int8_t getResponse(uint8_t cmd, uint8_t *response, size_t sz);
+		bool verifyCrc(const std::vector<uint8_t>& msg);
+};
+
+extern void adaptiveSensorUartCallback(UART_HandleTypeDef *huart);
+
+#endif /* ADAPTIVESENSORHW_HPP_ */

Bench/AdaptiveSensor/Inc/AdaptiveSensorSim.hpp

@@ -0,0 +1,31 @@
+#ifndef ADAPTIVESENSORSIM_HPP_
+#define ADAPTIVESENSORSIM_HPP_
+
+#include "AdaptiveSensor.hpp"
+
+/**
+ * @brief Simulation implementation of the AdaptiveSensor for testing.
+ */
+class AdaptiveSensorSim : public AdaptiveSensor
+{
+	public:
+		/**
+		 * @brief Initialize the simulated heater.
+		 */
+		void init() override;
+
+		int8_t boardReset() override;
+		int8_t hardReset() override;
+		int8_t softReset() override;
+
+		int8_t getFlowMeasurement(int32_t *value) override;
+
+		int8_t getSwVersion(char swVersion[ADAPT_SW_VER_STRLEN]) override;
+		int8_t getHwVersion(char hwVersion[ADAPT_HW_VER_STRLEN]) override;
+		int8_t getArticle(char article[ADAPT_ART_STRLEN]) override;
+
+	private:
+
+};
+
+#endif /* ADAPTIVESENSORSIM_HPP_ */

Bench/AdaptiveSensor/Src/AdaptiveSensorControl.cpp

@@ -0,0 +1,24 @@
+#include "main.h"
+
+#include "AdaptiveSensorControl.hpp"
+
+AdaptiveSensorControl::AdaptiveSensorControl()
+{
+	m_sensorSim = std::make_unique<AdaptiveSensorSim>();
+	m_sensorHw = std::make_unique<AdaptiveSensorHw>(ADS_UART, ADS_RE_GPIO_Port, ADS_RE_Pin);
+}
+
+void AdaptiveSensorControl::init()
+{
+#ifdef ERCPSIM
+    m_sensor = m_sensorSim.get();
+#else
+	m_sensor = m_sensorHw.get();
+#endif
+	m_sensor->init();
+}
+
+void AdaptiveSensorControl::serviceTask()
+{
+	// Since adaptive sensor can be hotplugged, maybe check here to see if it's attached
+}