Initial commit

include/README

@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

include/opst.h

@@ -0,0 +1,85 @@
+/**
+ * @file opst.h
+ * @author Pascal Lais (pascal_lais@gmx.de)
+ *
+ * @version 0.1
+ * @date 2020-08-02
+ */
+
+#ifndef OPST_H_INCLUDED
+#define OPST_H_INCLUDED
+
+//-----------------------------------------------------------------------------
+// Includes
+//-----------------------------------------------------------------------------
+
+//-----------------------------------------------------------------------------
+// Defines
+//-----------------------------------------------------------------------------
+
+//-----------------------------------------------------------------------------
+// Datatypes
+//-----------------------------------------------------------------------------
+
+typedef enum eagOpstState
+{
+    OPST_STATE_NONE,
+    OPST_STATE_REPORT_TEMP,
+    OPST_STATE_REPORT_PRESSURE,
+    OPST_STATE_TEMP_FAULT,
+    OPST_STATE_PRESSURE_FAULT,
+    OPST_STATE_HARDWARE_FAULT,
+}eOpstState;
+
+//-----------------------------------------------------------------------------
+// Variables
+//-----------------------------------------------------------------------------
+
+//-----------------------------------------------------------------------------
+// Function prototypes
+//-----------------------------------------------------------------------------
+
+/**
+ * Init opst handling
+ *
+ * @param pin The pin that connects to the output pin of the sensor. Only pin 2 or 3 can be used here.
+ */
+void opstInit(uint8_t pin);
+
+/**
+ * OPS+T sensor pwm data handling. Call this in the loop function.
+ */
+void opstUpdate();
+
+/**
+ * Get the current state of the sensor.
+ *
+ * @return One of eOpstState
+ */
+uint32_t opstGetState();
+
+/**
+ * Get the temperature value.
+ *
+ * @return Temperature vale in 0.1 °C steps (ie 274 for 27.4 °C)
+ */
+int32_t opstGetTemp();
+
+/**
+ * Get the pressure value
+ *
+ * @return Pressure in millibar
+ */
+int32_t opstGetPressure();
+
+/**
+ * Check fifo for overruns. If overrun was detected increase fifo size.
+ *
+ * @return True if fifo overrun was detected at any time.
+ */
+bool opstFiFoOverrunDetected();
+
+#endif //OPST_H_INCLUDED
+//-----------------------------------------------------------------------------
+// EOF
+//-----------------------------------------------------------------------------

include/sys.h

@@ -0,0 +1,43 @@
+/**
+ * @file sys.h
+ * @author Pascal Lais (pascal_lais@gmx.de)
+ *
+ * @version 0.1
+ * @date 2020-08-02
+ */
+
+#ifndef SYS_H_INCLUDED
+#define SYS_H_INCLUDED
+
+//-----------------------------------------------------------------------------
+// Includes
+//-----------------------------------------------------------------------------
+
+//-----------------------------------------------------------------------------
+// Defines
+//-----------------------------------------------------------------------------
+
+//-----------------------------------------------------------------------------
+// Datatypes
+//-----------------------------------------------------------------------------
+
+//-----------------------------------------------------------------------------
+// Variables
+//-----------------------------------------------------------------------------
+
+//-----------------------------------------------------------------------------
+// Function prototypes
+//-----------------------------------------------------------------------------
+
+void sysInit();
+void sysLoop(uint32_t ts);
+void sysLoop10ms(uint32_t ts);
+void sysLoop50ms(uint32_t ts);
+void sysLoop100ms(uint32_t ts);
+void sysLoop500ms(uint32_t ts);
+void sysLoop1000ms(uint32_t ts);
+
+#endif //SYS_H_INCLUDED
+//-----------------------------------------------------------------------------
+// EOF
+//-----------------------------------------------------------------------------