-
Notifications
You must be signed in to change notification settings - Fork 0
Repository Documentation
Hovhannes Apinyan edited this page Apr 17, 2024
·
3 revisions
This documentation provides an overview of the structure and purpose of the repository, detailing the contents of each directory and their roles within the project.
The app directory serves as the core component of the project, responsible for reading sensor data, sending it via MQTT, or storing it in a local database. Below is a breakdown of its contents:
-
data: Contains modules related to data handling.
- data_handler.py: Module for handling data.
- local_db.py: Module for interacting with the local database.
- mqtt_client.py: Module for sending data via MQTT.
- scripts: Holds various scripts used within the project for tasks such as data splitting, network checking, etc.
-
sensors: Houses sensor modules organized by type.
- other_sensors: Modules for miscellaneous sensors.
- weather_meter_sensors: Modules specifically for weather-related sensors.
- config.py: Configuration file for the AllInOne module.
- logger_config.py: Configuration file for logging settings.
- main.py: Main entry point for the AllInOne functionality.
- requirements.txt: File listing required Python packages.
- testing.py: Script is designed to assess the functionality of sensors and services.
The ServiceFiles directory holds service files that can be utilized within the system for various purposes.
- InternetCheckConnect: Service files for internet connection checking.
- ProgramAutoRun: Service files for automatic program execution.
The install.sh script is responsible for performing initial setup and configuration of the system, particularly on Raspberry Pi devices, to prepare for the project's operation.