Smart Biogas API documentation

Smart Biogas API documentation

Introduction

Welcome to the Smart Biogas REST API documentation!


Begin

API tokens are distributed to all users. Log in to Smart Biogas and go to the 'Settings' section of the platform which can be accessed in the secondary drop down menu next to the profile icon. Here you will be able to generate an API key that is unique to your user. You will need to submit this key in an authorization header along with every request you make. If you do not see your API key, get in touch with a member of staff at support@smartbiogas.io

 

Documentation

Documentation is maintained in Swagger in an open API spec here: https://api.smartbiogas.io/open-api
This can also be downloaded in json format here: https://api.smartbiogas.io/open-api.json

At the moment, there is only 1 API to receive raw data from a smart meter. There will be more to follow.

 

Outputs

Parameter

 Type Description
timestamp string ISO format (date, datetime and timezone)
staticpressurePa number

The static pressure in pascals.
flowLph number The flow of gas in litres per hour.
volumeL number Gas volume passed through the meter in litres. This is an ever increasing counter.
batteryV number Battery voltage in volts.
batteryA number Battery charging current in amps.
solarV
 number The voltage of the solar input in volts.
tempInternalDegC
 number The temperature measured by the CPU in degrees celsius.
tempExternalDegC
number
If an NTC thermistor is attached to the RJ45 port, a temperature is shown in degrees celsius, else NULL
rssiDb
 number

Signal strength in dB. The scale is from 0 to -120. The closer to 0, the stronger the signal.

 
 

    • Related Articles

    • Smart Biogas Overview

      What is a Smart Biogas meter? Smart Biogas is a real-time monitoring system for biogas digesters. It is connected between digester and stove or other biogas appliance and sends flow and Pressure data to the software app, enabling performance ...

    • Navigating the Smart Biogas Platform

      The navigation bar is your gateway to managing biogas operations efficiently. It allows you to: Monitor and manage biogas systems View and update customer information Register and track smart meters Add and configure digesters and appliancesThe ...

    • Managing Biogas Systems – In-Depth Guide

      The Systems page provides tools to efficiently manage all registered biogas systems. 1. Viewing Biogas Systems All registered biogas systems are displayed in a table format, allowing users to: See system details at a glance Scroll through the list of ...

    • How to Add a New Biogas System

      To register a new biogas system, follow these steps: Click the "Add a new System" button on the Dashboard or on the Systems page. Enter system details, including: System name Address External reference (optional) Installation notes (if any) Select ...

    • Editing or Updating a Biogas System

      To make changes to an existing Biogas system, follow these steps: Locate the System Go to the Systems tab. Use search or filters to find the system. Click on the system to open its details. Edit System Details On the details screen, click the "Edit ...