Initial commit

Author: nitko12

LICENSE

@@ -0,0 +1,49 @@
+# NAZIV PROIZVODA Arduino library
+
+[![Compile Sketches](http://github-actions.40ants.com/e-radionicacom/Soldered-Generic-Arduino-Library/matrix.svg?branch=dev&only=Compile%20Sketches)](https://github.com/e-radionicacom/Soldered-Generic-Arduino-Library/actions/workflows/compile_test.yml)
+[![Make docs and publish to GitHub Pages](https://github.com/e-radionicacom/Soldered-Generic-Arduino-Library/actions/workflows/make_docs.yml/badge.svg?branch=dev)](https://github.com/e-radionicacom/Soldered-Generic-Arduino-Library/actions/workflows/make_docs.yml)
+
+| ![Product name](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) |
+| :---------------------------------------------------------------------------------------------: |
+| [NAZIV PROIZVODA](https://www.solde.red/SKU)                                                            |
+
+OPIS PROIZVODA + LINK NA [easyC ecosystem](https://www.soldered.com/easyC). 
+
+### Repository Contents
+- **/src** - source files for the library (.h & .cpp)
+- **/examples** - examples for using the library
+- ***other*** - *keywords* file highlights function words in your IDE, *library.properties* enables implementation with Arduino Library Manager.
+
+### Hardware design
+You can find hardware design for this board in NAZIV PROIZVODA hardware repository
+
+### Documentation
+
+Access Arduino library documentation [here](https://e-radionicacom.github.io/Soldered-Generic-Arduino-Library/).
+
+- Tutorial for using the NAZIV PROIZVODA board
+- Installing an Arduino library
+
+### About Soldered
+![Soldered logo](https://raw.githubusercontent.com/e-radionicacom/Soldered-Generic-Arduino-Library/dev/extras/Logo%20horizontal-2.svg)
+
+At Soldered, we design and manufacture a wide selection of electronic products to help you turn your ideas into acts and bring you one step closer to your final project. Our products are intented for makers and crafted in-house by our experienced team in Osijek, Croatia. We believe that sharing is a crucial element for improvement and innovation, and we work hard to stay connected with all our makers regardless of their skill or experience level. Therefore, all our products are open-source. Finally, we always have your back. If you face any problem concerning either your shopping experience or your electronics project, our team will help you deal with it, offering efficient customer service and cost-free technical support anytime. Some of those might be useful for you:
+
+- [Web Store](https://www.soldered.com)
+- [Educational content](https://learn.soldered.com)
+- [Community & technical support](https://community.soldered.com)
+- [Custom PCBs](https://pcb.soldered.com)
+
+
+### Original source
+​
+This library is possible thanks to original [arduino-mcp23017](https://github.com/blemasle/arduino-mcp23017) library. Thank you, blemasle. 
+
+
+### Open-source license
+Soldered invests vast amounts of time into hardware & software for these products, which are all open-source. Please support future development by buying one of our products. 
+
+Check license details in the LICENSE file. Long story short, use these open-source files for any purpose you want to, as long as you apply the same open-source licence to it and disclose the original source. No warranty - all designs in this repository are distributed in the hope that they will be useful, but without any warranty. They are provided "AS IS", therefore without warranty of any kind, either expressed or implied. The entire quality and performance of what you do with the contents of this repository are your responsibility. In no event, Soldered (TAVU) will be liable for your damages, losses, including any general, special, incidental or consequential damage arising out of the use or inability to use the contents of this repository. 
+
+Thank you from your fellow makers at Soldered.
+

README.md

@@ -0,0 +1,20 @@
+/**
+ **************************************************
+ *
+ * @file        Template.ino
+ * @brief       Example template for easyC sensors
+ *
+ *
+ *
+ * @authors     @ soldered.com
+ ***************************************************/
+
+#include "Generic-easyC-SOLDERED.h"
+
+void setup()
+{
+}
+
+void loop()
+{
+}

examples/Template/Template.ino

@@ -0,0 +1,17 @@
+##################################################
+# Syntax Coloring Map For Obstacle-Sensor-SOLDERED
+##################################################
+
+##################################################
+# Datatypes (KEYWORD1)
+##################################################
+
+##################################################
+# Methods and Functions (KEYWORD2)
+##################################################
+
+begin	KEYWORD2
+
+##################################################
+# Constants (LITERAL1)
+##################################################

keywords.txt

@@ -0,0 +1,10 @@
+name=easyC_template
+version=0.1.0
+author=Soldered
+maintainer=Soldered <[email protected]>
+sentence=Only a template used to create other libraries
+paragraph=Template, should not be used like this
+category=Sensor
+url=www.soldered.com
+architectures=*
+includes=Generic-easyC-SOLDERED.h

library.properties

@@ -0,0 +1,32 @@
+/**
+ **************************************************
+ *
+ * @file        Generic-easyC-SOLDERED.cpp
+ * @brief       Example functions to overload in base class.
+ *
+ *
+ * @copyright GNU General Public License v3.0
+ * @authors     @ soldered.com
+ ***************************************************/
+
+
+#include "Generic-easyC-SOLDERED.h"
+
+/**
+ * @brief                   Sensor specific native constructor.
+ *
+ * @param int _pin          Example parameter.
+ */
+Sensor::Sensor(int _pin)
+{
+    pin = _pin;
+    native = 1;
+}
+
+/**
+ * @brief                   Overloaded function for virtual in base class to initialize sensor specific.
+ */
+void Sensor::initializeNative()
+{
+    pinMode(pin, INPUT);
+}

src/Generic-easyC-SOLDERED.cpp

@@ -0,0 +1,30 @@
+/**
+ **************************************************
+ *
+ * @file        Generic-easyC-SOLDERED.h
+ * @brief       Header file for sensor specific code.
+ *
+ *
+ * @copyright GNU General Public License v3.0
+ * @authors     @ soldered.com
+ ***************************************************/
+
+#ifndef __SENSOR__
+#define __SENSOR__
+
+#include "Arduino.h"
+#include "libs/Generic-easyC/easyC.h"
+
+class Sensor : public EasyC
+{
+  public:
+    Sensor(int _pin);
+
+  protected:
+    void initializeNative();
+
+  private:
+    int pin;
+};
+
+#endif

src/Generic-easyC-SOLDERED.h

@@ -0,0 +1,115 @@
+/**
+ **************************************************
+ *
+ * @file        easyC.cpp
+ * @brief       Basic funtions for easyC
+ *
+ *
+ * @copyright GNU General Public License v3.0
+ * @authors     @ soldered.com
+ ***************************************************/
+
+#include "easyC.h"
+
+/**
+ * @brief       Main constructor for easyC version
+ *
+ */
+EasyC::EasyC()
+{
+    native = 0;
+}
+
+/**
+ * @brief       Initializes sensors on native or easyC on default address
+ */
+void EasyC::begin()
+{
+    if (native)
+        initializeNative();
+    else
+        begin(defaultAddress);
+
+    beginDone = 1;
+}
+
+/**
+ * @brief                  Initializes sensors on supplied i2c address
+ *
+ * @param uint8_t _address Custom easyC sensor address
+ */
+void EasyC::begin(uint8_t _address)
+{
+    address = _address;
+
+    Wire.begin();
+
+    beginDone = 1;
+}
+
+/**
+ * @brief                   Private function to send over i2c and then read n bytes
+ *
+ * @param char regAddr      Address of register to access data from
+ * @param char a            Array to put data in
+ * @param size_t n          Size of data to read
+ *
+ * @return int              0 if read successfuly, error code from endTransmission if not
+ */
+int EasyC::readRegister(char regAddr, char a[], size_t n)
+{
+    if (sendAddress(regAddr))
+        return err;
+
+    if (readData(a, n))
+        return err;
+
+    return 0;
+}
+
+/**
+ * @brief                Private function to send a single byte to sensor
+ *
+ * @param  char regAddr  Address of register to access later
+ *
+ * @return int           Standard endTransmission error codes
+ */
+int EasyC::sendAddress(char regAddr)
+{
+    Wire.beginTransmission(address);
+    Wire.write(regAddr);
+
+    return err = Wire.endTransmission();
+}
+
+/**
+ * @brief           Private function to read n bytes over i2c
+ *
+ * @param  char a[] Array to read data to
+ * @param  int n    Number of bytes to read
+ *
+ * @return int      Error code, always 0
+ */
+int EasyC::readData(char a[], int n)
+{
+    Wire.requestFrom(address, n);
+    Wire.readBytes(a, n);
+
+    return 0;
+}
+
+/**
+ * @brief           Private function to write n bytes over i2c
+ *
+ * @param char a[]  Array to read data from
+ * @param int n     Number of bytes to read
+ *
+ * @return int       Standard endTransmission error codes
+ */
+int EasyC::sendData(const uint8_t *a, int n)
+{
+    Wire.beginTransmission(address);
+    Wire.write(a, n);
+
+    return err = Wire.endTransmission();
+}

src/libs/Generic-easyC/easyC.cpp

@@ -0,0 +1,46 @@
+/**
+ **************************************************
+ *
+ * @file        easyC.h
+ * @brief       Basic funtions for easyC libraries
+ *
+ *
+ * @copyright GNU General Public License v3.0
+ * @authors     @ soldered.com
+ ***************************************************/
+
+#ifndef __EASYC_LIBRARY__
+#define __EASYC_LIBRARY__
+
+#include "Arduino.h"
+#include "Wire.h"
+
+#define ANALOG_READ_REG  0
+#define DIGITAL_READ_REG 1
+
+class EasyC
+{
+  public:
+    EasyC();
+
+    void begin();
+    void begin(uint8_t _address);
+
+  protected:
+    int native = 0;
+    bool beginDone = 0;
+
+    virtual void initializeNative() = 0;
+
+    int err;
+
+    char address;
+    const char defaultAddress = 0x30;
+
+    int sendAddress(char regAddr);
+    int readData(char a[], int n);
+    int sendData(const uint8_t *a, int n);
+    int readRegister(char regAddr, char a[], size_t n);
+};
+
+#endif