code

Author: mestrode

example/basic/src/main.cpp

@@ -1,13 +1,15 @@
 #include <Arduino.h>
 #include <TJA1020.hpp>
+#include <LinFrameTransfer.hpp>
 
-#define PIN_NSLP 23
+constexpr int PIN_NSLP = 23;
 
 // using a TJA1020 chip
 // using UART 1 for LinBus
 // configure 19200 Baud
 // using GPIO 23 for /NSLP pin of TJA1020
-Lin_TJA1020 LinBus(1, 19200, PIN_NSLP);
+Lin_TJA1020 linBus(1, 19200, PIN_NSLP);
+LinFrameTransfer linMaster(linBus, Serial, 2);
 
 // data to be filled by bus request
 float Cap_Max = 0.0;
@@ -23,29 +25,40 @@ void setup()
 
   // configure slope rate
   Serial.print("configure low slope rate of TJA1020\n");
-  LinBus.setSlope(LinBus.LowSlope);
+  linBus.setSlope(Lin_TJA1020::Mode::LowSlope);
 }
 
 bool readLinData()
 {
-  // all handling of
-  bool chkSumValid = LinBus.readFrame(0x2C);
-  if (chkSumValid)
+  auto rawData = linMaster.readFrame(0x2C);
+  if (!rawData)
   {
-    // Data now avaliabele in LinBus.LinMessage
+    return false;
+  }
 
-    // decode some bytes (incl. rescaling)
-    Cap_Max = (float((LinBus.LinMessage[1] << 8) + LinBus.LinMessage[0])) / 10;
-    Cap_Available = (float((LinBus.LinMessage[3] << 8) + LinBus.LinMessage[2])) / 10;
+  // Data now avaliabele in data.value() or at address data.data()
+  struct ResponseCap {
+    uint8_t capMax_LSB;
+    uint8_t capMax_MSB;
+    uint8_t capAvaliable_LSB;
+    uint8_t capAvaliable_MSB;
+    uint8_t capConfigured;
+    uint8_t capFlags;
+  };
+  ResponseCap* data = reinterpret_cast<ResponseCap*>(rawData.value().data());
 
-    // receive a single byte
-    Cap_Configured = LinBus.LinMessage[4];
+  // decode some bytes (incl. rescaling)
+  Cap_Max = ((data->capMax_MSB << 8) + data->capMax_LSB) / 10;
+  Cap_Available = (float((data->capAvaliable_MSB << 8) + data->capAvaliable_LSB)) / 10;
 
-    // decode flags within a byte
-    CalibByte = LinBus.LinMessage[5];
-    CalibrationDone = bitRead(LinBus.LinMessage[5], 0);
-  }
-  return chkSumValid;
+  // receive a single byte
+  Cap_Configured = data->capConfigured;
+
+  // decode flags within a byte
+  CalibByte = data->capFlags;
+  CalibrationDone = bitRead(data->capFlags, 0);
+
+  return true;
 }
 
 void loop()
@@ -63,5 +76,5 @@ void loop()
   delay(5000);
 
   //shut TJA1020 down, this also releases the INH pin.
-  LinBus.setSlope(LinBus.Sleep);
+  linBus.setSlope(Lin_TJA1020::Mode::Sleep);
 }

library.json

@@ -1,6 +1,6 @@
 {
   "name": "Lin-Transceiver",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "utilizes a LIN Transceiver TJA1020: Sleep / NormalSlope / LowSlope",
   "keywords": [
     "TJA1020",
@@ -21,7 +21,7 @@
   "dependencies": [
     {
       "name": "Lin-Interface",
-      "version": "https://github.com/mestrode/Lin-Interface-Library"
+      "version": "https://github.com/mestrode/Lin-Interface-Library.git"
     }
   ]
 }

library.properties

@@ -0,0 +1,43 @@
+[env]
+
+[env:test-native]
+platform = native
+
+build_type = debug
+build_flags =
+    -DUNIT_TEST
+    -Isrc
+    -Itest
+    -std=gnu++17
+
+test_framework = unity
+test_build_src = true
+;test_filter = native/test_LinFrameTransfer
+;test_filter = native/test_LinTransportLayer
+;test_filter = native/test_LinNodeConfig
+debug_test = *
+
+lib_deps =
+    https://github.com/mestrode/Lin-Interface-Library.git
+    Arduino
+
+lib_ldf_mode = chain+
+
+
+[env:example-basic]
+platform = espressif32@^6.9.0
+board = esp32dev
+framework = arduino
+
+src_dir = example/basic/src
+lib_extra_dirs = src
+
+build_flags =
+    -std=gnu++17
+build_unflags =
+    -std=gnu++11
+
+lib_deps =
+    https://github.com/mestrode/Lin-Interface-Library.git
+
+lib_ldf_mode = chain+

platformio.ini

@@ -10,54 +10,37 @@
 
 #include "TJA1020.hpp"
 
-#include <Lin_Interface.hpp>
-// #include <Arduino.h>
+#ifdef UNIT_TEST
+    #include "mock_HardwareSerial.h"
+    using HardwareSerial = mock_HardwareSerial;
+    #include "mock_delay.h"
+#else
+    #include <Arduino.h>
+#endif
 
 constexpr auto BAUD_DEFAULT = 19200;
 
 //-----------------------------------------------------------------------------
 // constructor
 
 /// Provides HW UART via TJA1020 Chip
-Lin_TJA1020::Lin_TJA1020(const int uart_nr, const uint32_t _baud, const int8_t rxPin, const int8_t txPin, const int8_t nslpPin) : Lin_Interface(uart_nr),
-    _tx_pin(txPin),
-    _nslp_pin(nslpPin)
+Lin_TJA1020::Lin_TJA1020(const int _uart_nr, const uint32_t _baud, const int8_t _rxPin, const int8_t _txPin, const int8_t _nslpPin) :
+    HardwareSerial(_uart_nr),
+    txPin(_txPin),
+    nslpPin(_nslpPin)
 {
     // use default baud rate, if not specified
-    Lin_Interface::baud = _baud ? _baud : BAUD_DEFAULT;
-    Lin_Interface::rxPin = rxPin;
-    Lin_Interface::txPin = txPin;
+// TODO:    HardwareSerial::baudRate = _baud ? _baud : BAUD_DEFAULT;
+    HardwareSerial::setPins(_rxPin, _txPin);
 }
 
 //-----------------------------------------------------------------------------
-// write / read  on bus
-
-/// Requests a Lin 2.0 Frame
-bool Lin_TJA1020::readFrame(const uint8_t FrameID)
-{
-    setMode(_writingSlope);
-    return Lin_Interface::readFrame(FrameID);
-}
-
-/// Sends a Lin 2.0 Frame
-bool Lin_TJA1020::writeFrame(const uint8_t FrameID, const size_t size)
-{
-    setMode(_writingSlope);
-    return Lin_Interface::writeFrame(FrameID, size);
-}
-
-/// Sends a Lin 1.3 Frame (Legacy Checksum)
-void Lin_TJA1020::writeFrameClassic(const uint8_t FrameID, const size_t size)
-{
-    setMode(_writingSlope);
-    Lin_Interface::writeFrameClassic(FrameID, size);
-}
 
 /// does control sequences to switch from one to another operational mode of the chip
 /// NormalSlope, LowSlope for writing operation;
 /// Sleep will release INH and may disables Power-Supply
 /// @param mode TJA1020 Mode to be the next
-void Lin_TJA1020::setMode(const TJA1020_Mode mode)
+void Lin_TJA1020::setMode(const Mode mode)
 {
     // we don't need to act, if we're allready there
     // see "setMode(sleep)" in the switch below
@@ -66,55 +49,55 @@ void Lin_TJA1020::setMode(const TJA1020_Mode mode)
         return;
     }
 
-    pinMode(_tx_pin, OUTPUT);   //  TX  Signal to LIN Tranceiver
-    pinMode(_nslp_pin, OUTPUT); // /SLP Signal to LIN Tranceiver
+    pinMode(txPin, OUTPUT);   //  TX  Signal to LIN Tranceiver
+    pinMode(nslpPin, OUTPUT); // /SLP Signal to LIN Tranceiver
 
     // Statemachine des TJA1020 von [SLEEP] nach [NORMAL SLOPE MODE] ändern
     switch (mode)
     {
-    case NormalSlope:
-        if (_currentMode == LowSlope)
+    case Mode::NormalSlope:
+        if (_currentMode == Mode::LowSlope)
         {
             // no direct step from LowSlope to NormalSlope
-            setMode(Sleep);
+            setMode(Mode::Sleep);
         }
 
         // rising edge on /SLP while TXD = 1
-        digitalWrite(_tx_pin, HIGH);
+        digitalWrite(txPin, HIGH);
         delayMicroseconds(10); // ensure signal to settle
 
         // create rising edge
-        digitalWrite(_nslp_pin, LOW);
+        digitalWrite(nslpPin, LOW);
         delayMicroseconds(15); //  ensure t_gotosleep (min. 10us)
-        digitalWrite(_nslp_pin, HIGH);
+        digitalWrite(nslpPin, HIGH);
         delayMicroseconds(15); // ensure t_gotonorm (min. 10us)
 
         // [Normal Slope Mode] reached
-        _currentMode = NormalSlope;
+        _currentMode = Mode::NormalSlope;
         break;
 
-    case LowSlope:
-        if (_currentMode == NormalSlope)
+    case Mode::LowSlope:
+        if (_currentMode == Mode::NormalSlope)
         {
             // no direct step from NormalSlope to LowSlope
-            setMode(Sleep);
+            setMode(Mode::Sleep);
         }
 
         // rising edge on /SLP while TXD = 0
-        digitalWrite(_tx_pin, LOW);
+        digitalWrite(txPin, LOW);
         delayMicroseconds(10); // ensure signal to settle
 
         // create rising edge
-        digitalWrite(_nslp_pin, LOW);
+        digitalWrite(nslpPin, LOW);
         delayMicroseconds(15); //  ensure t_gotosleep (min. 10us)
-        digitalWrite(_nslp_pin, HIGH);
+        digitalWrite(nslpPin, HIGH);
         delayMicroseconds(15); // ensure t_gotonorm (min. 10us)
 
         // release tx pin, to avoid occupation of Lin Bus
-        digitalWrite(_tx_pin, HIGH);
+        digitalWrite(txPin, HIGH);
 
         // [Low Slope Mode] reached
-        _currentMode = LowSlope;
+        _currentMode = Mode::LowSlope;
         break;
 
     default: // = Sleep
@@ -123,37 +106,37 @@ void Lin_TJA1020::setMode(const TJA1020_Mode mode)
         setMode(_writingSlope);
 
         // rising edge on /SLP while TXD = 1
-        digitalWrite(_tx_pin, HIGH);
+        digitalWrite(txPin, HIGH);
         delayMicroseconds(10); // ensure signal to settle
 
         // create falling edge
-        digitalWrite(_nslp_pin, HIGH);
+        digitalWrite(nslpPin, HIGH);
         delayMicroseconds(15); //  ensure t_gotosleep (min. 10us)
-        digitalWrite(_nslp_pin, LOW);
+        digitalWrite(nslpPin, LOW);
         delayMicroseconds(15); // ensure t_gotonorm (min. 10us)
         // INH will be shut down by constant low, chip will go into sleep mode
 
         // ensure pin level while sleeping
 #ifdef ESP32
-        pinMode(_tx_pin, INPUT_PULLDOWN);   // ensure Low level while in sleep mode (since TJA1020 has internally a fixed pulldown)
-        pinMode(_nslp_pin, INPUT_PULLDOWN); // ensure Low level while in sleep mode
+        pinMode(txPin, INPUT_PULLDOWN);   // ensure Low level while in sleep mode (since TJA1020 has internally a fixed pulldown)
+        pinMode(nslpPin, INPUT_PULLDOWN); // ensure Low level while in sleep mode
 #else
-        pinMode(_tx_pin, INPUT);   // ensure Low level while in sleep mode (since TJA1020 has internally a fixed pulldown)
-        pinMode(_nslp_pin, INPUT); // ensure Low level while in sleep mode
+        pinMode(txPin, INPUT);   // ensure Low level while in sleep mode (since TJA1020 has internally a fixed pulldown)
+        pinMode(nslpPin, INPUT); // ensure Low level while in sleep mode
 #endif
 
         // [Sleep] reached
-        _currentMode = Sleep;
+        _currentMode = Mode::Sleep;
         break;
     }
 } // void Lin_TJA1020::setMode(TJA1020_Mode newMode)
 
 /// Defines standard slope, to be used, when writing to the bus
-void Lin_TJA1020::setSlope(const TJA1020_Mode slope)
+void Lin_TJA1020::setSlope(const Mode slope)
 {
     _writingSlope = slope;
-    if (_writingSlope == Sleep)
+    if (_writingSlope == Mode::Sleep)
     {
-        _writingSlope = NormalSlope;
+        _writingSlope = Mode::NormalSlope;
     }
 }

src/TJA1020.cpp

@@ -10,12 +10,18 @@
 
 #pragma once
 
-#include <Lin_Interface.hpp>
+#ifdef UNIT_TEST
+    #include "mock_Arduino.h"
+    #include "mock_HardwareSerial.h"
+    using HardwareSerial = mock_HardwareSerial;
+#else
+    #include <Arduino.h>
+#endif
 
-class Lin_TJA1020 : public Lin_Interface
+class Lin_TJA1020 : public HardwareSerial
 {
 public:
-    enum TJA1020_Mode
+    enum class Mode
     {
         Sleep,
         NormalSlope,
@@ -26,22 +32,18 @@ class Lin_TJA1020 : public Lin_Interface
     /// @param uart_nr Index of HW UART to be used (0..2)
     /// @param baud Baud rate for RX/TX (0 = default 19200 baud)
     /// @param nslpPin /SLP Pin to control TJA1020
-    Lin_TJA1020(const int uart_nr, const uint32_t _baud, const int8_t rxPin, const int8_t txPin, const int8_t nslpPin);
-
-    bool readFrame(const uint8_t FrameID);
-    bool writeFrame(const uint8_t FrameID, const size_t size);
-    void writeFrameClassic(const uint8_t FrameID, const size_t size);
+    Lin_TJA1020(const int _uart_nr, const uint32_t _baud, const int8_t _rxPin, const int8_t _txPin, const int8_t _nslpPin);
 
     /// switches the operational mode of TJA1020 chip
     /// @param mode target mode
-    void setMode(const TJA1020_Mode mode);
+    void setMode(const Mode mode);
     /// Defines standard slope rate, when using to the bus
     /// @param slope "NormalSlope" or "LowSlope" is only valid
-    void setSlope(const TJA1020_Mode slope);
+    void setSlope(const Mode slope);
 
 private:
-    TJA1020_Mode _writingSlope = NormalSlope;
-    TJA1020_Mode _currentMode = Sleep;
-    int8_t _tx_pin;
-    int8_t _nslp_pin;
+    Mode _writingSlope = Mode::NormalSlope;
+    Mode _currentMode = Mode::Sleep;
+    int8_t txPin;
+    int8_t nslpPin;
 };