.. _terkin-readme:

Terkin

.. container:: align-center

.. image:: https://assets.okfn.org/images/ok_buttons/ok_80x15_red_green.png
    :target: https://okfn.org/opendata/

.. image:: https://assets.okfn.org/images/ok_buttons/oc_80x15_blue.png
    :target: https://okfn.org/opendata/

.. image:: https://assets.okfn.org/images/ok_buttons/os_80x15_orange_grey.png
    :target: https://okfn.org/opendata/

|

.. figure:: https://ptrace.getkotori.org/2016-05-23_chart-recorder.png
    :alt: Chart recorder
    :width: 200px

*Data logging for humans, written in MicroPython.*

• Documentation: https://terkin.org/

• Source Code: https://github.com/hiveeyes/terkin-datalogger

• PyPI: https://pypi.org/project/terkin/

• Status:

  .. image:: https://github.com/hiveeyes/terkin-datalogger/workflows/Tests/badge.svg :target: https://github.com/hiveeyes/terkin-datalogger/actions?workflow=Tests :alt: CI outcome

  .. image:: https://codecov.io/gh/hiveeyes/terkin-datalogger/branch/main/graph/badge.svg :target: https://codecov.io/gh/hiveeyes/terkin-datalogger :alt: Test suite code coverage

  .. image:: https://img.shields.io/badge/MicroPython-3.4-green.svg?&color=blue :target: https://micropython.org

  .. image:: https://img.shields.io/pypi/pyversions/terkin.svg?label=CPython :target: https://pypi.org/project/terkin/ :alt: Supported Python versions

  .. image:: https://img.shields.io/pypi/v/terkin.svg :target: https://pypi.org/project/terkin/ :alt: Package version on PyPI

  .. image:: https://img.shields.io/pypi/status/terkin.svg :target: https://pypi.org/project/terkin/ :alt: Project status (alpha, beta, stable)

  .. image:: https://img.shields.io/pypi/l/terkin.svg :target: https://github.com/hiveeyes/terkin-datalogger/blob/main/LICENSE :alt: Project license

  .. image:: https://pepy.tech/badge/terkin/month :target: https://pepy.tech/project/terkin :alt: PyPI downloads per month

At a glance

Terkin is a flexible data logger application for MicroPython and CPython environments. It provides a lot of sensor-, networking- and telemetry-connectivity options.

Terkin has been conceived for the Bee Observer (BOB) and Hiveeyes projects and was funded by the BMBF.

• https://bee-observer.hiveeyes.org/bmbf-verbundprojekt
• https://community.hiveeyes.org/c/bee-observer

Features

Batteries included.

Overview

• Modular firmware framework
• Flexible configuration settings subsystem
• Compatible with MicroPython and CPython
• Concise, readable and modularized code which is easy to follow
• Decoupled code domains and data models for sensors vs. telemetry
• Based on approved modules from the MicroPython standard library
• Convenient development sandbox and test suite for quick iteration cycles

Architecture

• Datalogger and Device are singleton objects representing the data logger application and the logging device.

• Components of the sensor subsystem wrap hardware drivers to generalize sensor reading.

• The telemetry subsystem uses different transport adapters to implement various connectivity scenarios.

Hardware support

Architectures

• x86_64, ARM, ESP32, STM32

Platforms

• Genuine MicroPython: PYBOARD-D, TTGO T-Call, TTGO T-Beam
• Pycom MicroPython: WiPy, GPy, LoPy4, FiPy
• CPython: Linux x86_64, Linux ARM (BeagleBone, Odroid, Raspberry Pi), macOS, WSL

Peripherals

• Sensors: 1-Wire, I2C, ADC, System, WiFi
• Drivers: DS18B20, BME280, BMP280, SI7021, ADS1x15, HX711, MAX17043, DS3231, AT24C32, INA219
• Adapters: GPSD, EPSolar ViewStar PWM charge controller, Victron Energy VE.Direct MPPT charge controller, Raspberry Pi USV+
• Connectivity: WiFi, SIM800 for GPRS, SX127x for LoRa (LoPy4, FiPy and Dragino LoRa/GPS HAT), Sequans Monarch for LTE Cat M1 or LTE Cat NB1_
• Telemetry: WiFi/MQTT, WiFi/HTTP, SIM800/HTTP, LoRaWAN/TTN OTAA+ABP

Screenshots

Sensorkit and board

.. figure:: https://ptrace.hiveeyes.org/2019-06-17_bob-sensorkit-small.jpeg :target: https://ptrace.hiveeyes.org/2019-06-17_bob-sensorkit-large.jpeg

Bee Observer Sensorkit, assembled.

.. figure:: https://ptrace.hiveeyes.org/2019-06-17_bob-board-small.jpeg :target: https://ptrace.hiveeyes.org/2019-06-17_bob-board-large.jpeg

Bee Observer Board, assembled.

Console output

To get a better idea about how running this firmware will feel like when watching its log output, we collected some excerpts at Running the Terkin Datalogger_.

Getting started

Introduction

See Getting started with the Terkin Datalogger_.

The documentation covers the main features of the MicroPython datalogger firmware and walks you through the setup process of the development sandbox environment in detail.

If you feel you have questions about anything you might encounter during the setup and installation process or if you even have suggestions to improve things, feel free to get back to us by creating an issue on the GitHub repository.

Download

On the release page_ , bundles of the most recent software versions are available through .tar.gz and .zip archives. These are suitable for uploading through Pymakr or similar development environments / file synchronization tools.

Configuration

Copy the settings.example.py blueprint into settings.py and adjust each configuration setting appropriately. The documentation of all parameters is in the file itself and should be reasonably self-explanatory. For using Terkin with TTN/LoRaWAN find some more details here <https://github.com/hiveeyes/terkin-datalogger/blob/main/client/TTN/README.rst>_.

Sandbox setup

If you would like to contribute to the development or want to setup a development environment for running the head version of this software, please follow up at Setup Terkin Datalogger sandbox_ to read about how to install the MicroPython firmware development environment and other software components it relies on and how to configure it properly.

The programming environment is command line based and has been tested successfully on Linux, macOS and the Windows Subsystem for Linux (WSL) shipped with Windows 10.

Acknowledgements

This software is an effort of many people. Thanks to all the contributors_ who helped to co-create and conceive it in one way or another. You know who you are.

License

This project is licensed under the terms of the AGPL license.

Have fun!

.. _Setup Terkin Datalogger sandbox: https://terkin.org/docs/development/ .. _contributors: https://terkin.org/docs/project/contributors.html .. _create an issue: https://github.com/hiveeyes/terkin-datalogger/issues/new .. _Getting started with the Terkin Datalogger: https://terkin.org/docs/getting-started/ .. _Running the Terkin Datalogger: https://terkin.org/docs/gallery/screenshots/05-running.html .. _release page: https://github.com/hiveeyes/terkin-datalogger/releases

.. _Pycom FiPy: https://pycom.io/product/fipy/ .. _Pycom LoPy4: https://pycom.io/product/lopy4/ .. _Pycom WiPy3: https://pycom.io/product/wipy-3-0/

.. _LTE Cat M1: https://docs.pycom.io/tutorials/lte/cat-m1.html .. _LTE Cat NB1: https://docs.pycom.io/tutorials/lte/nb-iot.html

.. _GNU-AGPL-3.0: https://opensource.org/licenses/AGPL-3.0 .. _EUPL-1.2: https://opensource.org/licenses/EUPL-1.2

.. _Dragino LoRa/GPS HAT: https://wiki.dragino.com/index.php?title=Lora/GPS_HAT