{"id":13802661,"url":"https://github.com/hiveeyes/terkin-datalogger","last_synced_at":"2025-08-22T20:20:26.000Z","repository":{"id":37898051,"uuid":"173368449","full_name":"hiveeyes/terkin-datalogger","owner":"hiveeyes","description":"Datalogger for MicroPython and CPython.","archived":false,"fork":false,"pushed_at":"2022-12-03T23:35:39.000Z","size":1534,"stargazers_count":60,"open_issues_count":31,"forks_count":28,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-10-30T00:36:09.890Z","etag":null,"topics":["beehive-monitoring","circuitpython","datalogger","esp32","gprs","gsm","http","hx711","kotori-daq","lora","lorawan","micropython","mqtt","sensor-network","sim800","sx127x","telematics","ttn"],"latest_commit_sha":null,"homepage":"https://terkin.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hiveeyes.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-01T21:09:51.000Z","updated_at":"2024-10-03T12:42:51.000Z","dependencies_parsed_at":"2022-08-20T03:00:23.231Z","dependency_job_id":null,"html_url":"https://github.com/hiveeyes/terkin-datalogger","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiveeyes%2Fterkin-datalogger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiveeyes%2Fterkin-datalogger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiveeyes%2Fterkin-datalogger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiveeyes%2Fterkin-datalogger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hiveeyes","download_url":"https://codeload.github.com/hiveeyes/terkin-datalogger/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238059129,"owners_count":19409601,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["beehive-monitoring","circuitpython","datalogger","esp32","gprs","gsm","http","hx711","kotori-daq","lora","lorawan","micropython","mqtt","sensor-network","sim800","sx127x","telematics","ttn"],"created_at":"2024-08-04T00:01:49.756Z","updated_at":"2025-02-10T04:31:13.700Z","avatar_url":"https://github.com/hiveeyes.png","language":"Python","funding_links":[],"categories":["Frameworks"],"sub_categories":["Utilities"],"readme":".. _terkin-readme:\n\n######\nTerkin\n######\n\n.. container:: align-center\n\n    .. image:: https://assets.okfn.org/images/ok_buttons/ok_80x15_red_green.png\n        :target: https://okfn.org/opendata/\n\n    .. image:: https://assets.okfn.org/images/ok_buttons/oc_80x15_blue.png\n        :target: https://okfn.org/opendata/\n\n    .. image:: https://assets.okfn.org/images/ok_buttons/os_80x15_orange_grey.png\n        :target: https://okfn.org/opendata/\n\n    |\n\n    .. figure:: https://ptrace.getkotori.org/2016-05-23_chart-recorder.png\n        :alt: Chart recorder\n        :width: 200px\n\n    *Data logging for humans, written in MicroPython.*\n\n----\n\n- **Documentation**: https://terkin.org/\n\n- **Source Code**: https://github.com/hiveeyes/terkin-datalogger\n\n- **PyPI**: https://pypi.org/project/terkin/\n\n- **Status**:\n\n  .. image:: https://github.com/hiveeyes/terkin-datalogger/workflows/Tests/badge.svg\n        :target: https://github.com/hiveeyes/terkin-datalogger/actions?workflow=Tests\n        :alt: CI outcome\n\n  .. image:: https://codecov.io/gh/hiveeyes/terkin-datalogger/branch/main/graph/badge.svg\n        :target: https://codecov.io/gh/hiveeyes/terkin-datalogger\n        :alt: Test suite code coverage\n\n  .. image:: https://img.shields.io/badge/MicroPython-3.4-green.svg?\u0026color=blue\n        :target: https://micropython.org\n\n  .. image:: https://img.shields.io/pypi/pyversions/terkin.svg?label=CPython\n        :target: https://pypi.org/project/terkin/\n        :alt: Supported Python versions\n\n  .. image:: https://img.shields.io/pypi/v/terkin.svg\n        :target: https://pypi.org/project/terkin/\n        :alt: Package version on PyPI\n\n  .. image:: https://img.shields.io/pypi/status/terkin.svg\n        :target: https://pypi.org/project/terkin/\n        :alt: Project status (alpha, beta, stable)\n\n  .. image:: https://img.shields.io/pypi/l/terkin.svg\n        :target: https://github.com/hiveeyes/terkin-datalogger/blob/main/LICENSE\n        :alt: Project license\n\n  .. image:: https://pepy.tech/badge/terkin/month\n        :target: https://pepy.tech/project/terkin\n        :alt: PyPI downloads per month\n\n----\n\n\n***********\nAt a glance\n***********\n\nTerkin is a flexible data logger application for MicroPython and\nCPython environments. It provides a lot of sensor-, networking-\nand telemetry-connectivity options.\n\nTerkin has been conceived for the Bee Observer (BOB)\nand Hiveeyes projects and was funded by the BMBF.\n\n- https://bee-observer.hiveeyes.org/bmbf-verbundprojekt\n- https://community.hiveeyes.org/c/bee-observer\n\n\n********\nFeatures\n********\nBatteries included.\n\nOverview\n========\n- Modular firmware framework\n- Flexible configuration settings subsystem\n- Compatible with MicroPython and CPython\n- Concise, readable and modularized code which is easy to follow\n- Decoupled code domains and data models for sensors vs. telemetry\n- Based on approved modules from the MicroPython standard library\n- Convenient development sandbox and test suite for quick iteration cycles\n\nArchitecture\n============\n- ``Datalogger`` and ``Device``\n  are singleton objects representing the data logger application and the logging device.\n\n- Components of the sensor subsystem wrap hardware drivers to generalize sensor reading.\n\n- The telemetry subsystem uses different transport adapters to\n  implement various connectivity scenarios.\n\n\n****************\nHardware support\n****************\n\nArchitectures\n=============\n- x86_64, ARM, ESP32, STM32\n\nPlatforms\n=========\n- Genuine MicroPython: PYBOARD-D, TTGO T-Call, TTGO T-Beam\n- Pycom MicroPython: WiPy, GPy, LoPy4, FiPy\n- CPython: Linux x86_64, Linux ARM (BeagleBone, Odroid, Raspberry Pi), macOS, WSL\n\nPeripherals\n===========\n- Sensors: 1-Wire, I2C, ADC, System, WiFi\n- Drivers: DS18B20, BME280, BMP280, SI7021, ADS1x15, HX711, MAX17043, DS3231, AT24C32, INA219\n- Adapters: GPSD, EPSolar ViewStar PWM charge controller, Victron Energy VE.Direct MPPT charge controller, Raspberry Pi USV+\n- 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`_\n- Telemetry: WiFi/MQTT, WiFi/HTTP, SIM800/HTTP, LoRaWAN/TTN OTAA+ABP\n\n\n***********\nScreenshots\n***********\n\nSensorkit and board\n===================\n.. figure:: https://ptrace.hiveeyes.org/2019-06-17_bob-sensorkit-small.jpeg\n    :target: https://ptrace.hiveeyes.org/2019-06-17_bob-sensorkit-large.jpeg\n\n    Bee Observer Sensorkit, assembled.\n\n.. figure:: https://ptrace.hiveeyes.org/2019-06-17_bob-board-small.jpeg\n    :target: https://ptrace.hiveeyes.org/2019-06-17_bob-board-large.jpeg\n\n    Bee Observer Board, assembled.\n\n\nConsole output\n==============\nTo get a better idea about how running this firmware will feel like when\nwatching its log output, we collected some excerpts at\n`Running the Terkin Datalogger`_.\n\n\n***************\nGetting started\n***************\n\nIntroduction\n============\nSee `Getting started with the Terkin Datalogger`_.\n\nThe documentation covers the main features of the MicroPython datalogger firmware\nand walks you through the setup process of the development sandbox environment\nin detail.\n\nIf you feel you have questions about anything you might \nencounter during the setup and installation process or \nif you even have suggestions to improve things, feel free\nto get back to us by creating an issue on the GitHub repository.\n\nDownload\n========\nOn the `release page`_ , bundles of the most recent software versions\nare available through ``.tar.gz`` and ``.zip`` archives.\nThese are suitable for uploading through Pymakr or similar\ndevelopment environments / file synchronization tools.\n\nConfiguration\n=============\nCopy the ``settings.example.py`` blueprint into ``settings.py``\nand adjust each configuration setting appropriately. The\ndocumentation of all parameters is in the file itself\nand should be reasonably self-explanatory.\nFor using Terkin with TTN/LoRaWAN find some more details\n`here \u003chttps://github.com/hiveeyes/terkin-datalogger/blob/main/client/TTN/README.rst\u003e`_.\n\nSandbox setup\n=============\nIf you would like to contribute to the development or want to setup\na development environment for running the head version of this\nsoftware, please follow up at `Setup Terkin Datalogger sandbox`_\nto read about how to install the MicroPython firmware development environment\nand other software components it relies on and how to configure it properly.\n\nThe programming environment is command line based and has been tested\nsuccessfully on **Linux**, **macOS** and the Windows Subsystem for Linux (WSL)\nshipped with **Windows 10**.\n\n\n****************\nAcknowledgements\n****************\nThis software is an effort of many people. Thanks to all the\n`contributors`_ who helped to co-create and conceive\nit in one way or another. You know who you are.\n\n\n*******\nLicense\n*******\nThis project is licensed under the terms of the AGPL license.\n\n\n\n----\n\nHave fun!\n\n\n.. _Setup Terkin Datalogger sandbox: https://terkin.org/docs/development/\n.. _contributors: https://terkin.org/docs/project/contributors.html\n.. _create an issue: https://github.com/hiveeyes/terkin-datalogger/issues/new\n.. _Getting started with the Terkin Datalogger: https://terkin.org/docs/getting-started/\n.. _Running the Terkin Datalogger: https://terkin.org/docs/gallery/screenshots/05-running.html\n.. _release page: https://github.com/hiveeyes/terkin-datalogger/releases\n\n.. _Pycom FiPy: https://pycom.io/product/fipy/\n.. _Pycom LoPy4: https://pycom.io/product/lopy4/\n.. _Pycom WiPy3: https://pycom.io/product/wipy-3-0/\n\n.. _LTE Cat M1: https://docs.pycom.io/tutorials/lte/cat-m1.html\n.. _LTE Cat NB1: https://docs.pycom.io/tutorials/lte/nb-iot.html\n\n.. _GNU-AGPL-3.0: https://opensource.org/licenses/AGPL-3.0\n.. _EUPL-1.2: https://opensource.org/licenses/EUPL-1.2\n\n.. _Dragino LoRa/GPS HAT: https://wiki.dragino.com/index.php?title=Lora/GPS_HAT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiveeyes%2Fterkin-datalogger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhiveeyes%2Fterkin-datalogger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiveeyes%2Fterkin-datalogger/lists"}