Compare commits

..

2 Commits

Author SHA1 Message Date
5ae0cdfc08 Remove clangd linting errors 2025-11-25 16:36:51 +01:00
03131b65f1 Adapt the project to the SCD41 sensor 2025-11-25 16:36:51 +01:00
12 changed files with 139 additions and 198 deletions

View File

@@ -1,10 +1,6 @@
* Muraqib * Muraqib
CO2 sensor that collects and sends its data via MQTT to a server. The board of the sensor is the Wemos D1 mini ESP32 and the sensor is a SCD41. CO2 sensor that collects and sends its data via MQTT to a server. The board of the sensor is the Wemos D1 mini and the sensor is a SCD41.
#+ATTR_HTML: :width 40%
[[./board.jpg]]
** Pinout of the board ** Pinout of the board
@@ -13,7 +9,7 @@ CO2 sensor that collects and sends its data via MQTT to a server. The board of t
** Dependencies ** Dependencies
- [[https://github.com/Sensirion/arduino-i2c-scd4x][Sensirion I²C SCD4X Arduino Library]] - [[https://github.com/Sensirion/arduino-i2c-scd4x][Sensirion I²C SCD4X Arduino Library]]
- [[https://github.com/marvinroger/async-mqtt-client][Async MQTT client]] - [[https://github.com/knolleary/pubsubclient][PubSubClient]]
- [[https://github.com/bblanchon/ArduinoJson][ArduinoJSON]] - [[https://github.com/bblanchon/ArduinoJson][ArduinoJSON]]
** Configuration ** Configuration

BIN
board.jpg

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.4 MiB

View File

@@ -7,5 +7,6 @@
"mqtt_port": 1883, "mqtt_port": 1883,
"mqtt_topic": "", "mqtt_topic": "",
"device_id": "", "device_id": "",
"sleep_time": 30 "sleep_time": 30,
"connection_attempts": 60
} }

6
flake.lock generated
View File

@@ -2,11 +2,11 @@
"nodes": { "nodes": {
"nixpkgs": { "nixpkgs": {
"locked": { "locked": {
"lastModified": 1773046814, "lastModified": 1744646643,
"narHash": "sha256-3CEw64UyzEk5QjfbcXNIl4TfmIpa2oY+duuo6aiawcU=", "narHash": "sha256-gswCvHOZvcHtY/5fIWYlz/VxMAIUQ6XFRZB/rxlH3OA=",
"owner": "NixOS", "owner": "NixOS",
"repo": "nixpkgs", "repo": "nixpkgs",
"rev": "0c6c0dd2469abaa216599bb19bbf77a328af6564", "rev": "a6165272f0074877f7c0c45fe6eba86d1e18e80d",
"type": "github" "type": "github"
}, },
"original": { "original": {

View File

@@ -1,6 +1,8 @@
#ifndef CONFIG_H_ #ifndef CONFIG_H_
#define CONFIG_H_ #define CONFIG_H_
#include "FS.h"
#include "LittleFS.h"
#include <ArduinoJson.h> #include <ArduinoJson.h>
typedef struct { typedef struct {
@@ -12,13 +14,14 @@ typedef struct {
const char *topic; const char *topic;
const char *device_id; const char *device_id;
int mqtt_port; int mqtt_port;
unsigned long sleep_time; long sleep_time;
int connection_attempts;
} Config; } Config;
void initialize_config(Config *config, JsonDocument json); void initialize_config(Config *config, JsonDocument json);
bool load_config_file(const char *file_path, Config *config); bool load_config_file(const char *file_path, Config *config);
long minutes_to_milliseconds(int minutes); long minutes_to_microseconds(int minutes);
#endif // CONFIG_H_ #endif // CONFIG_H_

View File

@@ -1,14 +0,0 @@
#ifndef SENSOR_H_
#define SENSOR_H_
#include <SensirionI2cScd4x.h>
void handle_error(int code, char *msg);
void initialize_sensor(SensirionI2cScd4x &sensor, int error_code,
char *error_msg);
void read_values(SensirionI2cScd4x &sensor, float *data, int error_code,
char *error_msg);
#endif // SENSOR_H_

View File

@@ -2,30 +2,15 @@
#define WLAN_H #define WLAN_H
#include "config.h" #include "config.h"
#include <AsyncMqttClient.h> #include <ESP8266WiFi.h>
#include <Ticker.h> #include <PubSubClient.h>
#include <WiFi.h>
static AsyncMqttClient mqtt_client;
static Ticker mqtt_connection_timer, wlan_connection_timer;
extern Config *config;
void initialize_wlan();
void initialize_mqtt();
void connect_wlan();
void connect_mqtt();
void wlan_connection_handler(WiFiEvent_t event);
void on_mqtt_connection(bool session);
void on_mqtt_disconnection(AsyncMqttClientDisconnectReason reason);
void initial_connection(const char *ssid, const char *psk,
const char *hostname);
void connect_wlan(Config *config);
void connect_mqtt(PubSubClient &client, Config *config);
void disconnect_mqtt(PubSubClient &client, const char *topic);
size_t construct_json(float *data, char *buffer, int buffer_size); size_t construct_json(float *data, char *buffer, int buffer_size);
void mqtt_transfer(PubSubClient &client, Config *config, float *data);
void mqtt_transfer(float *data);
#endif /* WLAN_H */ #endif /* WLAN_H */

View File

@@ -9,13 +9,13 @@
; https://docs.platformio.org/page/projectconf.html ; https://docs.platformio.org/page/projectconf.html
[env:d1_mini] [env:d1_mini]
platform = espressif32 platform = espressif8266
board = wemos_d1_mini32 board = d1_mini
board_build.filesystem = littlefs board_build.filesystem = littlefs
framework = arduino framework = arduino
monitor_filters = esp32_exception_decoder monitor_filters = esp8266_exception_decoder
lib_deps = lib_deps =
sensirion/Sensirion I2C SCD4x@^1.1.0 sensirion/Sensirion I2C SCD4x@^1.1.0
marvinroger/AsyncMqttClient@^0.9.0 knolleary/PubSubClient@^2.8
bblanchon/ArduinoJson@^7.4.1 bblanchon/ArduinoJson@^7.4.1

View File

@@ -1,5 +1,4 @@
#include "config.h" #include "config.h"
#include "LittleFS.h"
void initialize_config(Config *config, JsonDocument json) { void initialize_config(Config *config, JsonDocument json) {
config->ssid = strdup(json["ssid"]); config->ssid = strdup(json["ssid"]);
@@ -10,7 +9,8 @@ void initialize_config(Config *config, JsonDocument json) {
config->topic = strdup(json["mqtt_topic"]); config->topic = strdup(json["mqtt_topic"]);
config->device_id = strdup(json["device_id"]); config->device_id = strdup(json["device_id"]);
config->mqtt_port = json["mqtt_port"]; config->mqtt_port = json["mqtt_port"];
config->sleep_time = minutes_to_milliseconds(json["sleep_time"]); config->sleep_time = minutes_to_microseconds(json["sleep_time"]);
config->connection_attempts = json["connection_attempts"];
} }
bool load_config_file(const char *file_path, Config *config) { bool load_config_file(const char *file_path, Config *config) {
@@ -27,4 +27,4 @@ bool load_config_file(const char *file_path, Config *config) {
return true; return true;
} }
long minutes_to_milliseconds(int minutes) { return (minutes * 6e4); } long minutes_to_microseconds(int minutes) { return (minutes * 6e7); }

View File

@@ -1,37 +1,64 @@
#include "sensor.h" #include "config.h"
#include "wlan.h" #include "wlan.h"
#include <Arduino.h> #include <Arduino.h>
#include <SensirionI2cScd4x.h>
#include <Wire.h>
#define DHTTYPE DHT22
#define DHTPIN 4
SensirionI2cScd4x sensor; SensirionI2cScd4x sensor;
int error_code; int error;
char error_msg[64]; static char errorMessage[64];
const char *config_file_path = "/config.json"; const char *config_file_path = "/config.json";
long inactivity_delay;
Config *config; Config *config;
WiFiClient wifi_client;
PubSubClient mqtt_client(wifi_client);
float data[3]; int check_error(int error) {
unsigned long previous_millis = 0; if (error) {
Serial.println("Error while initializing sensor");
errorToString(error, errorMessage, sizeof errorMessage);
return 1;
}
return 0;
}
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
config = (Config *)malloc(sizeof(Config)); Wire.begin();
sensor.begin(Wire, SCD41_I2C_ADDR_62);
if (!load_config_file(config_file_path, config)) error = sensor.wakeUp();
Serial.println("ERROR: The config file could not be loaded"); error = sensor.stopPeriodicMeasurement();
error = sensor.reinit();
initialize_wlan(); error = sensor.startPeriodicMeasurement();
initialize_mqtt(); inactivity_delay = 60000;
connect_wlan();
initialize_sensor(sensor, error_code, error_msg);
} }
void loop() { void loop() {
unsigned long current_millis = millis(); uint16_t co2_concentration = 0.0;
float temperature = 0.0;
float humidity = 0.0;
bool data_available = false;
if (current_millis - previous_millis >= config->sleep_time) { error = sensor.getDataReadyStatus(data_available);
previous_millis = current_millis; error = sensor.readMeasurement(co2_concentration, temperature, humidity);
read_values(sensor, data, error_code, error_msg);
mqtt_transfer(data); if (data_available) {
Serial.print("CO2 concentration [ppm]: ");
Serial.print(co2_concentration);
Serial.println();
Serial.print("Temperature [°C]: ");
Serial.print(temperature);
Serial.println();
Serial.print("Relative Humidity [RH]: ");
Serial.print(humidity);
Serial.println();
} else {
Serial.println(".");
} }
delay(inactivity_delay);
} }

View File

@@ -1,49 +0,0 @@
#include "sensor.h"
#include <Wire.h>
// TODO Trigger a reset when an error occurs
void handle_error(int code, char *msg) {
if (code) {
errorToString(code, msg, sizeof msg);
exit(1);
}
}
void initialize_sensor(SensirionI2cScd4x &sensor, int error_code,
char *error_msg) {
Wire.begin();
sensor.begin(Wire, SCD41_I2C_ADDR_62);
Serial.println("Starting sensor initialization");
error_code = sensor.wakeUp();
handle_error(error_code, error_msg);
error_code = sensor.stopPeriodicMeasurement();
handle_error(error_code, error_msg);
error_code = sensor.reinit();
handle_error(error_code, error_msg);
error_code = sensor.startPeriodicMeasurement();
handle_error(error_code, error_msg);
Serial.println("The sensor was initialized properly");
};
void read_values(SensirionI2cScd4x &sensor, float *data, int error_code,
char *error_msg) {
bool data_available = false;
short unsigned int co2_concentration = 0.0;
error_code = sensor.getDataReadyStatus(data_available);
handle_error(error_code, error_msg);
while (!data_available) {
delay(100);
error_code = sensor.getDataReadyStatus(data_available);
handle_error(error_code, error_msg);
}
Serial.println("Data fetched from the sensor");
error_code = sensor.readMeasurement(co2_concentration, data[1], data[2]);
data[0] = co2_concentration;
handle_error(error_code, error_msg);
}

View File

@@ -1,61 +1,53 @@
#include "wlan.h" #include "wlan.h"
#include <ArduinoJson.h>
void initialize_wlan() { WiFi.onEvent(wlan_connection_handler); } void initial_connection(const char *ssid, const char *psk,
const char *hostname) {
void initialize_mqtt() { WiFi.hostname(hostname);
mqtt_client.onConnect(on_mqtt_connection); WiFi.begin(ssid, psk);
mqtt_client.onDisconnect(on_mqtt_disconnection); WiFi.persistent(true);
mqtt_client.setServer(config->mqtt_host, config->mqtt_port); WiFi.setAutoConnect(true);
mqtt_client.setCredentials(config->mqtt_user, config->mqtt_password); WiFi.setAutoReconnect(true);
Serial.println("MQTT initialization complete");
} }
void connect_wlan() { WiFi.begin(config->ssid, config->psk); } void connect_wlan(Config *config) {
if (WiFi.SSID() != config->ssid)
void connect_mqtt() { initial_connection(config->ssid, config->psk, config->device_id);
Serial.println("Connecting to MQTT"); while (WiFi.status() != WL_CONNECTED) {
mqtt_client.connect(); delay(1000);
Serial.print(".");
} }
void wlan_connection_handler(WiFiEvent_t event) {
Serial.printf("[WiFi-event] event: %d\n", event);
switch (event) {
case SYSTEM_EVENT_STA_GOT_IP:
Serial.println("WiFi connected"); Serial.println("WiFi connected");
connect_mqtt(); }
break;
case SYSTEM_EVENT_STA_DISCONNECTED: void connect_mqtt(PubSubClient &client, Config *config) {
Serial.println("WiFi disconnected"); if (!client.connected())
mqtt_connection_timer.detach(); client.setServer(config->mqtt_host, config->mqtt_port);
wlan_connection_timer.once(2, connect_wlan); if (client.connect(config->device_id, config->mqtt_user,
break; config->mqtt_password)) {
Serial.println("MQTT connected");
client.subscribe(config->topic);
} }
} }
void on_mqtt_connection(bool session) { Serial.println("MQTT connected"); }; void disconnect_mqtt(PubSubClient &client, const char *topic) {
Serial.println("Disconnecting MQTT");
void on_mqtt_disconnection(AsyncMqttClientDisconnectReason reason) { client.unsubscribe(topic);
Serial.println("MQTT disconnected"); client.disconnect();
if (WiFi.isConnected()) {
mqtt_connection_timer.once(2, connect_mqtt);
}
} }
size_t construct_json(float *data, char *buffer, int buffer_size) { size_t construct_json(float *data, char *buffer, int buffer_size) {
JsonDocument json; JsonDocument json;
json["co2_concentration"] = data[0]; json["temperature"] = data[0];
json["temperature"] = data[1]; json["humidity"] = data[1];
json["humidity"] = data[2];
size_t payload_size = serializeJson(json, buffer, buffer_size); size_t payload_size = serializeJson(json, buffer, buffer_size);
return payload_size; return payload_size;
} }
void mqtt_transfer(float *data) { void mqtt_transfer(PubSubClient &client, Config *config, float *data) {
char buffer[100]; char buffer[100];
connect_mqtt(client, config);
size_t payload_size = construct_json(data, buffer, 100); size_t payload_size = construct_json(data, buffer, 100);
uint16_t response = client.publish(config->topic, buffer, payload_size);
mqtt_client.publish(config->topic, 2, true, buffer, payload_size);
if (response)
Serial.println("Data transferred successfully"); Serial.println("Data transferred successfully");
} }