Basic example added

Author: mestrode

README.md

@@ -7,7 +7,9 @@ The HardwareSerial UART of an ESP32 is used. (But in the past I used a software
 I've used a TJA1020 Transceiver on HW side in my project. The chip contains a statemachine, which needs to be controlled before you will be able to write or receive data. To keep thinks easy, I created a derived class (from this one) which consider the statemachine every time using the bus: https://github.com/mestrode/Lin-Transceiver-Library
 
 # example
-Take a look into this repo to see, how this works: https://github.com/mestrode/IBS-Sensor-Library
+Need a basic example: Take a look into the example folder.
+
+More complex example: Take a look into this repo to see, how this works: https://github.com/mestrode/IBS-Sensor-Library
 
 This code calls some methods of BatSensor which utilizes the Lin-Interface
 
@@ -56,7 +58,6 @@ The aktual data handling looks like this:
 
    bool IBS_Sensor::readFrameCapacity()
     {
-
         bool chkSumValid = LinBus->readFrame(IBS_FrameID[_SensorNo][IBS_FRM_CAP]);
         if (chkSumValid)
         {

example/basic/platformio.ini

@@ -0,0 +1,16 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env:esp32doit-devkit-v1]
+platform = espressif32
+board = esp32doit-devkit-v1
+framework = arduino
+lib_deps =
+    https://github.com/mestrode/Lin-Interface-Library.git

example/basic/src/main.cpp

@@ -0,0 +1,57 @@
+#include <Arduino.h>
+#include <Lin-Interface.hpp>
+
+// using UART 1 for LinBus
+Lin_Interface LinBus(1);
+
+// data to be filled by bus request
+float Cap_Max = 0.0;
+float Cap_Available = 0.0;
+uint8_t Cap_Configured = 0;
+uint8_t CalibByte = 0x00;
+bool CalibrationDone = false;
+
+void setup()
+{
+  Serial.begin(115200);
+
+  // configure baud rate
+  Serial.print("configure Lin-Bus to 19200 Baud\n");
+  LinBus.baud = 19200;
+}
+
+bool readLinData()
+{
+  bool chkSumValid = LinBus.readFrame(0x2C);
+  if (chkSumValid)
+  {
+    // Data now avaliabele in LinBus.LinMessage
+
+    // 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;
+
+    // receive a single byte
+    Cap_Configured = LinBus.LinMessage[4];
+
+    // decode flags within a byte
+    CalibByte = LinBus.LinMessage[5];
+    CalibrationDone = bitRead(LinBus.LinMessage[5], 0);
+  }
+  return chkSumValid;
+}
+
+void loop()
+{
+  if (readLinData())
+  {
+    Serial.print("Data reveived:\n");
+    Serial.printf("  Cap_Max = %f\n", Cap_Max);
+    Serial.printf("  Cap_Available = %f\n", Cap_Available);
+    Serial.printf("  Cap_Configured = %d\n", Cap_Configured);
+    Serial.printf("  CalibByte = %02Xh\n", CalibByte);
+    Serial.printf("  CalibrationDone = %d\n", CalibrationDone);
+  }
+
+  delay(5000);
+}