Skip to content

Created docs for Hydreon RG-15 #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
1 change: 1 addition & 0 deletions docs/hardware/accessoires/display.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import TutorialPorts from '@site/src/components/TutorialPorts/TutorialPorts'
Mit dem senseBox OLED Display lassen sich auf 128x64 Pixeln Messwerte, Statusmeldungen und vieles mehr anzeigen.

<ImageWithText src={display} alt="OLED Display" title="OLED Display" />

## Technische Informationen

- "Plug-in-and-Go" senseBox kompatibel durch Breakout-Board mit JST-Anschluss
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: RTC-Modul
hide_title: false
description: Mit dem RTC-Modul kann die Uhrzeit auch ohne Stromversorgung gespeichert werden.
---

import TutorialPorts from '@site/src/components/TutorialPorts/TutorialPorts'


# RTC-Modul

Das RTC-Modul ermöglicht es dir, die Uhrzeit auch ohne Stromversorgung zu speichern. Dies kann besonders nützlich sein, wenn keine Internetverbindung verfügbar ist und Messwerte offline z.B. auf der SD Karte gespeichert werden sollen. Damit die Uhrzeit auch ohne Stromversorgung gespeichert werden kann, ist zudem eine Knopfzellenbatterie von Nöten.
Expand All @@ -16,6 +20,8 @@ Das RTC-Modul ermöglicht es dir, die Uhrzeit auch ohne Stromversorgung zu speic

Nachdem die Knopfzellenbatterie in die Halterung eingefügt wurde, wird das RTC-Modul an einen I2C Anschluss der senseBox angeschlossen.

<TutorialPorts port="i2c" />


## Uhrzeit einrichten

Expand Down
119 changes: 119 additions & 0 deletions docs/hardware/accessoires/solar_set.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
---
sidebar_position: 25
title: Solar-Set
hide_title: false
description: senseBox Solarmodul Erweiterung
---

import Admonition from "@theme/Admonition";
import ImageWithText from '@site/src/components/ImageWithText/ImageWithText'
import solar from '@site/static/img/hardware-bilder/solar/solar.png'
import adapter from '@site/static/img/hardware-bilder/solar/solarcharger.png'
import TutorialPorts from '@site/src/components/TutorialPorts/TutorialPorts'

# Solar-Set

Das Solar-Set ermöglicht es, die senseBox autark mit Strom zu versorgen.
Das Set besteht aus einem Solarpanel, einem Laderegler (Powerbooster) und zwei LiPo-Akkus. Das Set ist ideal für den Einsatz im Freien, wo eine Stromversorgung über das Netz nicht möglich ist.

<ImageWithText src={solar} alt="Solar-Set" title="Solar-Set" />

<Admonition type="warning" title="Hinweis zur Kompabilität des Solar-Sets" className="text-left">
<p>
Das Solar-Set ist nur mit der senseBox MCU kompatibel, nicht mit der senseBox MCU S2.
</p>
</Admonition>

## Technische Informationen
- "Plug-in-and-Go" senseBox kompatibel
- Maße Solarpanel: 340mm x 235mm x 17mm
- Maße Powerbooster: 23mm x 45mm x 10mm
- Gewicht: ca. 1kg
- Maximale Leistung (Pm): 10W
- Klemmenspannung: 7.2V
- Spannung bei max. Leistung (Vm): 6V
- Kurzschlussstrom (Isc): 1.86A
- Zwei LiPo-Akkus mit je 3.7V und 3500mAh

## Anschluss
Der Powerbooster wird mit einem JST-Kabel an den I2C-Steckplatz der senseBox angeschlossen.
Das Solarmodul wird mit einem Kabel an den Powerbooster angeschlossen. Die Akkus werden direkt in den Powerbooster gesteckt.

<TutorialPorts port="i2c" />

<Admonition type="warning" title="Hinweis zur Verwendung der Akkus" className="text-left">
<p>
LiPo-Akkus können bei falscher Handhabung explodieren oder giftige Gase freisetzen. Vor dem Anschließen der Akkus an den Powerbooster sollte sichergestellt werden, dass kein Kurzschluss vorliegt und die Akkus in gutem Zustand sind.
Die Akkus sollten niemals mit spitzen Gegenständen perforiert werden oder ins Feuer geworden werden.
</p>
</Admonition>

## Laderegler (Powerbooster)
Der SolarCharger V1.0 sorgt durch integrierten Lade-Kreislauf dafür, dass die Solarzelle den Akku auflädt und der Akku seinerseits dann die senseBox betreibt.

<ImageWithText src={adapter} alt="Powerbooster" title="Powerbooster" />

<Admonition type="warning" title="Hinweis zur Verwendung des Powerboosters" className="text-left">
<p>
Der Powerbooster sollte am besten vor Nässe geschützt aufgebaut werden. Daher ist im Lieferumfang des Solar-Sets ein wasserdichtes Gehäuse enthalten, in dem der Powerbooster verbaut werden kann und soll.
Die Verwendung dieses Gehäuses ist empfehlenswert, um die Elektronik vor Witterungseinflüssen zu schützen.
</p>
</Admonition>

## Programmierung (Arduino)

Das Solar-Set kann in der senseBox Arduino IDE programmiert werden, um Informationen über den Ladezustand der Akkus und die Leistung der Solarzelle zu erhalten.
Allerdings ist es nicht zwingend notwendig, das Solar-Set zu programmieren, um es zu verwenden. Die senseBox ist so vorkonfiguriert, dass sie automatisch den Strom vom Powerbooster bezieht, sobald dieser angeschlossen ist.
Sollten die Akkus leer sein, wird die senseBox automatisch in den Energiesparmodus versetzt und verbraucht so wenig Strom wie möglich. Während dieser Zeit werden keine Messdaten erhoben.
Sobald die Akkus wieder aufgeladen sind, wird die senseBox automatisch wieder aktiviert.

```cpp
#include <SolarChargerSB041.h>
#include <senseBoxIO.h> // only needer fo senseBox MCU

SolarChargerSB041 charger;

void setup() {
charger.begin();
Serial.begin(9600);
}

void loop() {
charger.update();

Serial.print("Charger Connected: ");
Serial.println(charger.isChargerConnected() ? "true" : "false");
Serial.print("Solar Panel Voltage: ");
Serial.println(charger.getSolarPanelVoltage());
Serial.print("Battery Voltage: ");
Serial.println(charger.getBatteryVoltage());
Serial.print("Charging: ");
Serial.println(charger.isCharging() ? "true" : "false");
Serial.print("Fast Charging: ");
Serial.println(charger.isFastCharging() ? "true" : "false");
Serial.print("Battery Level: ");
Serial.println(charger.getBatteryLevel());
Serial.print("Good Input Voltage: ");
Serial.println(charger.isGoodInputVoltage() ? "true" : "false");
Serial.print("Battery Present: ");
Serial.println(charger.isBatteryPresent() ? "true" : "false");
Serial.print("Battery Temperature: ");
Serial.println(charger.getBatteryTemperature());
Serial.println();

delay(1000);
}
```

## Programmierung (Blockly)
In Blockly können Informationen über die Solarzelle und die Akkus über den Block `Solarladeregler` ausgelesen werden. Dieser Block ist im Bereich "Erweitert" zu finden.

![](/img/blockly-bilder/solar/solarladeregler.svg)

Außerdem ist es mit dem Block `Stromsparender Tiefschlaf und Neustart` möglich, den stromsparenden Tiefschlafmodus der senseBox zu kontrollieren und steuern.

![](/img/blockly-bilder/solar/tiefschlaf.svg)

## Weitere Informationen
> - [Shop](https://sensebox.kaufen/product/solar-set)
> - [SolarCharger V1.0 Datasheet](https://github.com/sensebox/solar-power-test/blob/master/senseBox_SolarCharger_V10.pdf)
2 changes: 1 addition & 1 deletion docs/hardware/bee/lora-bee.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Dies ist auf der [Karte](https://www.thethingsnetwork.org/community#list-communi

## Benutzung

Ein ausführliches Tutorials wie du das LoRa Bee in Verbindung mit der senseBoxMCU und dem [TheThingsNetwork](https://thethingsnetwork.org) verwenden kannst findest du [hier](/products/home/erweiterungen/home-erweiterung-LoRa).
Ein ausführliches Tutorials wie du das LoRa Bee in Verbindung mit der senseBoxMCU und dem [TheThingsNetwork](https://thethingsnetwork.org) verwenden kannst findest du [hier](/products/home/erweiterungen/home-erweiterung-lora/).

Das Blockly Tutorial zur LoRa Verwendung findest du [hier](/docs/editors/blockly/blocks/lora).

Expand Down
102 changes: 102 additions & 0 deletions docs/hardware/sensors/niederschlag-rg15.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
---
sidebar_position: 0
title: Niederschlagssensor
hide_title: false
description: Niederschlagssensor (RG15)
---

import ImageWithText from '@site/src/components/ImageWithText/ImageWithText'
import precipationSensor from '@site/static/img/hardware-bilder/niederschlag/sensor_niederschlag_rg15.png'
import adapter from '@site/static/img/hardware-bilder/niederschlag/adapterplatine_rg15.png'
import TutorialPorts from '@site/src/components/TutorialPorts/TutorialPorts'
import { useBoardStore } from '@site/src/lib/stores/store'

# Niederschlagssensor

Der Hydreon RG-15 ist ein präziser, wartungsfreier Niederschlagssensor, der mithilfe von Infrarottechnologie und einer speziellen Kunststofflinse die Niederschlagsmenge und -intensität erfasst.

<ImageWithText
src={precipationSensor}
alt="Niederschlagssensor"
title="Niederschlagssensor"
/>

## Technische Information
- "Plug-in-and-Go" senseBox kompatibel
- Maße: 121mm x 71mm x 56mm
- Abweichung bei Messungen von ±10%
- Messungen bei Temperaturen von -40°C bis +60°C (-40°F bis +140°F)
- Nominelle Stromzufuhr von 110 μA und 2-4 mA bei Niederschlag
- Betriebsspannung 5V oder 3.3V
- Serielle Schnittstelle (UART)

## Anschluss
<TutorialPorts port="uart" />

## Adapterplatine

Der RG-15 Sensor kann auf Grund unterschiedlicher Betriebsspannungen nicht direkt an die senseBox angeschlossen werden.
Daher ist eine Adapterplatine notwendig, die den Sensor mit der senseBox verbindet.
Diese Adapterplatine ist im Lieferumfang des Sensors enthalten und wird je nach senseBox Modell mit einem unterschiedlichen Kabel verbunden:

- senseBox MCU S2, bzw. senseBox:edu S2: Die Adapterplatine wird mit einem [QWIIC-Kabel SB-074](https://sensebox.kaufen/product/qwiic-kabel-500mm) verbunden.
- senseBox MCU, bzw. senseBox:edu: Die Adapterplatine wird mit einem [senseBox-Kabel SB-057](https://sensebox.kaufen/product/sensebox-kabel-jst-jst-500mm) verbunden.

<ImageWithText
src={adapter}
alt="Adapterplatine"
title="Adapterplatine"
/>

## Programmierung (Arduino)

### Software Bibliothek

Um den Sensor in Arduino zu Programmieren musst du die Software Bibliothek [RG15-Arduino](https://github.com/sensebox/rg15-arduino-lib) installieren.

### Code

Dieser Code gibt die Niederschlagsintensität im Seriellen Monitor aus. Über die Variablen `getEventAccumulation` und `getTotalAccumulation` kannst du auf die anderen Messwerte zugreifen. Die Variable `getAccumulation` gibt die Niederschlagsmenge seit der letzten Messung an.
Der Sensor wird im Beispiel über `Serial0` initialisiert, was der Standardport auf der senseBox MCU S2, bzw. senseBox:edu S2, ist. Auf der senseBox MCU, bzw. senseBox:edu, kann alternativ `Serial1` oder `Serial2` verwendet werden.

```cpp
#include <RG15.h> // https://github.com/sensebox/rg15-arduino-lib

// Initialise the RG15 through the serial port
RG15 rg15_Serial0(Serial0);

void setup(){
Serial.begin(9600);
delay(2000);
rg15_Serial0.begin();
rg15_Serial0.resetAccumulation();
}

void loop(){
rg15_Serial0.poll();
float intensity = rg15_Serial0.getRainfallIntensity();
Serial.print("Niederschlagsintensität: ");
Serial.print(intensity);
Serial.println(" mm/h");

delay(1000);
}
```

## Programmierung (Blockly)

In Blockly kann der Sensor über folgenden Block ausgelesen werden:

![](/img/hardware-bilder/niederschlag/niederschlag-blockly.svg)

Im Block kannst du zwischen den verschiedenen Parametern des Umweltsensors auswählen:
- Niederschlagsintensität in mm/h
- Niederschlagsmenge seit der letzten Messung in mm
- Gesamte Niederschlagsmenge in mm
- Niederschlag pro Event in mm

Zusätzlich kann dort der Serielle Port ausgewählt werden, an dem der Sensor angeschlossen ist.

## Extras
> - [Shop](https://sensebox.kaufen/product/hydreon-rg-15-regensensor)
> - [Hydreon RG-15 Datenblatt](https://rainsensors.com/wp-content/uploads/sites/3/2022/07/2022.07.18-rev-1.000-rg-15_instructions.pdf)
4 changes: 2 additions & 2 deletions docs/hardware/sensors/umweltsensor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ Mit dem Sensor BME680 kannst du eine verschiedene Auswahl an Phänomenen messen.

<ImageWithText src={umweltsensor} title="BME680 Umweltsensor" />

## Technische Details
## Technische Informationen

- Schnelle Reaktionszeit von weniger als 10 Sekunden
- "Plug-in-and-Go" senseBox kompatibel
- Abweichung bei Gasmessungen von +-15%
- Abweichung bei Gasmessungen von ±15%

## Anschluss

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ const config = {
},
{
label: 'openSenseMap',
to: 'https://opensensemap.org/impressum',
to: 'https://opensensemap.org/',
},
{
label: 'FAQ',
Expand Down
8 changes: 4 additions & 4 deletions i18n/en/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,13 @@
"message": ":edu",
"description": "The label for category :edu in sidebar senseBoxSidebar"
},
"sidebar.senseBoxSidebar.category.zusätzlich erwerbare Hardware": {
"sidebar.senseBoxSidebar.category.zusätzlich erwerbbare Hardware": {
"message": "Additional Hardware",
"description": "The label for category zusätzlich erwerbare Hardware in sidebar senseBoxSidebar"
"description": "The label for category zusätzlich erwerbbare Hardware in sidebar senseBoxSidebar"
},
"sidebar.senseBoxSidebar.category.zusätzlich erwerbare Hardware.link.generated-index.title": {
"sidebar.senseBoxSidebar.category.zusätzlich erwerbbare Hardware.link.generated-index.title": {
"message": "Additional Hardware",
"description": "The generated-index page title for category zusätzlich erwerbare Hardware in sidebar senseBoxSidebar"
"description": "The generated-index page title for category zusätzlich erwerbbare Hardware in sidebar senseBoxSidebar"
},
"sidebar.senseBoxSidebar.category.:bike": {
"message": ":bike",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ title: RTC-Modul
hide_title: false
description: Mit dem RTC-Modul kann die Uhrzeit auch ohne Stromversorgung gespeichert werden.
---

import TutorialPorts_en from '@site/src/components/TutorialPorts/TutorialPorts_en'

# RTC-Modul

The RTC module allows you to save the time even without a power supply. This can be particularly useful if no internet connection is available and measured values are to be saved offline, e.g. on the SD card. A button cell battery is also required so that the time can also be saved without a power supply.
Expand All @@ -14,6 +17,8 @@ The RTC module allows you to save the time even without a power supply. This can
## Connection
After inserting the button cell battery has been inserted into the holder, the RTC module is connected to an I2C port on the senseBox

<TutorialPorts_en port="i2c" />

## Setting the time

Before you use the RTC module, you must first set the initial time. This only needs to be done once, provided the battery is not disconnected from the module. In the following sketch, the time and date are set in the `setup` and output on the serial monitor in the `loop`. Remember to set the current time in the `setup` with the command `rtc.set(...)`.
Expand Down
Loading