arduino-weather-station

KO | EN

gitlite — search

#typescript #ai-agents #deepseek-harness #dsh-plugin #open-source #ai #claude-code #cli #windows #codex #developer-tools #dsh

arduino-weather-station

★ 95 Open GitHub ↗

Arduino Weather Station is an automated weather monitoring project built on Arduino for collecting environmental data, featuring an API (PHP + MySQL + CodeIgniter) and a web interface (Next.js + Redux RTK) for real-time and historical weather data analysis. Please give the project a star :)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Arduino Weather Station is a complete DIY weather-monitoring project powered by Arduino or ESP32. It collects real environmental data and provides a full backend API (PHP + MySQL + CodeIgniter) and a modern web interface (Next.js + Redux RTK) for real-time and historical weather analysis.
You can use this repository to build your own fully-featured weather station - and if you like it, please give the project a star :)

<h3>Arduino Weather Station</h3>

<a href="https://meteo.miksoft.pro" target="_blank">Demo</a>
·
<a href="https://github.com/miksrv/arduino-weather-station/issues/new?assignees=miksrv&labels=bug&projects=&template=1-bug.yml&title=%5BBug%5D%3A+">Report Bug</a>
·
<a href="https://github.com/miksrv/arduino-weather-station/issues/new?assignees=miksrv&labels=enhancement&template=2-feature-request.yml&title=%5BFeature%5D%3A+">Request Feature</a>
·
<a href="#contact">Contact</a>
</div>

<br />

<div align="center">

[![Contributors][contributors-badge]][contributors-url]
[![Forks][forks-badge]][forks-url]
[![Stargazers][stars-badge]][stars-url]
[![Issues][issues-badge]][issues-url]
[![MIT License][license-badge]][license-url]

[![UI Checks](https://github.com/miksrv/arduino-weather-station/actions/workflows/ui-checks.yml/badge.svg)](https://github.com/miksrv/arduino-weather-station/actions/workflows/ui-checks.yml)
[![UI Deploy](https://github.com/miksrv/arduino-weather-station/actions/workflows/ui-deploy.yml/badge.svg)](https://github.com/miksrv/arduino-weather-station/actions/workflows/ui-deploy.yml)
[![Arduino Code Check](https://github.com/miksrv/arduino-weather-station/actions/workflows/arduino-code-check.yml/badge.svg)](https://github.com/miksrv/arduino-weather-station/actions/workflows/arduino-code-check.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=miksrv_arduino-weather-station&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=miksrv_arduino-weather-station)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=miksrv_arduino-weather-station&metric=coverage)](https://sonarcloud.io/summary/new_code?id=miksrv_arduino-weather-station)

</div>

---

### Table of Contents

- [About of Project](#about-of-project)
    - [Key Features](#key-features)
    - [Measured Parameters](#measured-parameters)
    - [Built With](#built-with)
- [Build Guide](#build-guide)
- [Installation](#installation)
- [Usage](#usage)
- [Screenshots and Demos](#screenshots-and-demos)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgments](#acknowledgments)
- [Contact](#contact)

## Documentation

Detailed documentation lives in the [`/docs`](./docs) directory:

- [Architecture](./docs/architecture.md) — system design, data flow, external services
- [Backend](./docs/backend.md) — PHP/CodeIgniter API reference and setup
- [Frontend](./docs/frontend.md) — Next.js app structure and development
- [Development Guide](./docs/development.md) — local setup, commands, conventions
- [Testing Guide](./docs/testing.md) — running tests, coverage, CI pipeline
- [Anomaly Monitor](./docs/anomaly-monitor.md) — meteorological anomaly detection, flood risk scoring, and visualization
- [Precipitation Calendar](./docs/precipitation-calendar.md) — annual rainfall calendar, daily totals, wet/dry streaks, and monthly breakdown

## About of Project

Arduino Weather Station is a modular DIY platform for collecting and analyzing weather data. It supports Arduino or ESP32, works with a wide range of sensors, and sends real-time measurements to a backend server. Data is processed, stored, and exposed through a clean REST API and a modern Next.js dashboard.

![Arduino Weather Station](https://raw.githubusercontent.com/miksrv/arduino-weather-station/main/docs/arduino-weather-station-1.jpg)

### Key Features:
- **Live data**: continuous sensor monitoring.
- **Historical logging**: long-term storage in MySQL with detailed analytics.
- **Web dashboard**: access your station from anywhere — charts, stats, trends.
- **REST API**: integrate weather data into external apps or services.
- **Modular design**: easily add new sensors or expand the system.

### Measured Parameters:
- Temperature
- Feels like temperature
- Humidity
- Dew point
- UV intensity
- Solar energy
- Solar radiation
- Wind speed and direction
- Atmospheric pressure
- Precipitation levels
- Cloud cover

The system is highly customizable - from a small indoor sensor hub to a full outdoor weather station with complete data logging and visualization.

### Built With

The Arduino Weather Station project leverages a wide range of technologies across various layers of the system:

- [![C++][c++-badge]][c++-url] Programming language used for the Arduino firmware.
- [![PHP][php-badge]][php-url] Server-side scripting language for the backend API.
- [![MySQL][mysql-badge]][mysql-url] Database system for storing weather data.
- [![JavaScript][js-badge]][js-url] Core languages used in frontend development.
- [![TypeScript][ts-badge]][ts-url] TypeScript extends JavaScript by adding types to the language.
- [![NextJS][nextjs-badge]][nextjs-url] React-based frontend framework for building the user interface.
- [![Redux][redux-badge]][redux-url] State management for the frontend, providing predictable and centralized state.
- [![NodeJS][nodejs-badge]][nodejs-url] JavaScript runtime used for frontend development and package management.
- [![Sass][sass-badge]][sass-url] Styling the user interface.
- [![GitHub Actions][githubactions-badge]][githubactions-url] Continuous integration and deployment pipeline for automating tests and deployment processes.
- [![SonarCloud][sonarcloud-badge]][sonarcloud-url] Code quality and security analysis.

This project also includes custom-designed components for measuring airflow, voltage, and light, making use of 3D printing for hardware integration.

## Build Guide
This project is fairly extensive and includes hardware, firmware, backend, and frontend components. You can choose to build the entire weather station from start to finish, or you can use only the parts you need - whether it's the Arduino/ESP32 firmware, the server API, the 3D-printed enclosure, or the web dashboard.

The guide below walks you through each stage step by step: printing the enclosure, assembling the hardware, setting up the server, and configuring the client application.

### 3D Printing the Enclosure
All 3D-printable parts for the weather station are located in the [models](https://github.com/miksrv/arduino-weather-station/tree/main/models)
directory, which includes a detailed guide on recommended print settings, assembly notes, and an overview of each component.

The enclosure is fully modular and allows you to print only the parts needed for your specific sensor configuration. Most models are optimized for FDM 3D printers and require no supports unless otherwise noted.

Before printing, review the [Models README](./models/README.md) to choose the correct components and verify recommended materials and orientation.

## Installation

Follow these steps to install and run the Arduino Weather Station project on your local machine.

### Prerequisites

Make sure you have the following installed on your system:
- **Node.js** (v20 or higher)
- **NPM** or **Yarn** (for frontend dependencies)
- **PHP** (v8.2 or higher)
- **Composer** (for backend dependencies)
- **MySQL** (or any compatible database) — or **Docker** to run the bundled local database (see step 2 below)
- **Arduino IDE** (for programming the Arduino microcontroller)

### 1. Clone the repository

```bash
git clone https://github.com/miksrv/arduino-weather-station.git
cd arduino-weather-station
```

### 2. Backend Setup (PHP + CodeIgniter)

1. Navigate to the `server` folder:

```bash
   cd server
   ```

2. Install PHP dependencies using Composer:

```bash
   composer install
   ```

3. Start the local MySQL database using Docker (skip this if you already have a MySQL-compatible database running):

```bash
   docker-compose -f ../config/docker-compose.yml up -d
   ```

4. Create a `.env` file and configure your environment variables, such as database connection settings:

```bash
   cp env .env
   ```

The default `database.development.*` values already match the docker-compose database from step 3, so no changes are needed if you used Docker. Don't forget to set the parameter `app.arduino.token` = '' in the .env file. This token will be used for proper authentication of the Arduino weather station when transmitting data to the server. The same token will need to be set in the Arduino sketch, which will be described in step 4.

5. Migrate the database:

```bash
   php spark migrate
   ```

6. Start the backend server (built-in PHP server or any web server of your choice):

```bash
   php spark serve
   ```

### 3. Frontend Setup (Next.js + Redux)

1. Navigate to the `client` folder:

```bash
   cd ../client
   ```
   
2. Copy file `env` to `.env.local` and set the following environment variables:

```bash
   cp env .env.local
   ```
   
    ```bash
    NEXT_PUBLIC_API_HOST = 'http://localhost:8080/'
    NEXT_PUBLIC_SITE_LINK = 'http://localhost:3000/'
    NEXT_PUBLIC_STORAGE_KEY = 'meteo'
    ```

3. Install frontend dependencies:

```bash
   yarn install
   ```

4. Run the frontend in development mode:

```bash
   yarn run dev
   ```

5. To build the project for production:

```bash
   yarn run build
   ```

6. Optionally, start the production build:

```bash
   yarn start
   ```

### 4. Arduino Setup

1. Open the [Arduino Readme](./arduino/README.md) — it includes the full wiring diagram (which pin/wire connects to which component).
2. Open the Arduino sketch from the `arduino/main` folder in the Arduino IDE.
3. Configure the following parameters in the `main.ino` file for Arduino:
   - `API_SERVER` - the server address for sending data from the weather station.
   - `API_METHOD` - the correct method (if you haven't changed anything in the server settings in this repository, you don't need to change it).
   - `API_SECRET` - your secret for server authentication, the same secret key set in step 2 during server setup.
   - Make sure the Arduino sensors are connected to the correct pins, or simply reassign them: `PIN_ANEMOMETR`, `PIN_DHT22`, `PIN_UV_OUT`, `PIN_UV_REF`
3. Before compiling, make sure to install the required libraries:
    - Extract the **BMP085_Library.zip** and **PCF8574_Library.zip** archives from the `/arduino` directory into the `libraries` folder of your Arduino IDE.
4. Connect your Arduino microcontroller and upload the sketch.
5. Ensure the Arduino is correctly wired with the sensors for proper functionality.

#### Arduino Components:

- **BMP085**: Barometric pressure sensor
- **BH1750**: Light sensor
- **DHT22**: Temperature and humidity sensor
- **PCF8574**: I2C expander for wind direction
- **GUML8511**: UV sensor
- **Anemometer**: Measures wind speed
- **Wind Vane**: Measures wind direction

![Weather Station Wiring Diagram](https://raw.githubusercontent.com/miksrv/arduino-weather-station/main/docs/wiring-diagram.jpg)

All models for 3D printing can be found in the `models` directory.

![Arduino Weather Station](https://raw.githubusercontent.com/miksrv/arduino-weather-station/main/docs/models.jpg)

**Which filament / print settings should I use?** Don't overthink it - any
filament with default slicer settings works fine, and none of the parts need
supports. My own enclosure has been printed in plain **ABS** with default
settings, and it's been mounted outdoors since 2021, through everything from
+44°C summer sun to -37°C winter frost - nothing has cracked, warped, or
fallen apart.

### 5. Accessing the Application

Once the backend and frontend servers are running, access the weather station UI by visiting:

```
http://localhost:3000
```

You can now monitor real-time and historical weather data from the Arduino Weather Station!

## Usage

After successfully installing and setting up the Arduino Weather Station project, follow these steps to start using the application and monitor weather data.

### 1. Access the Web Interface

- Open your browser and navigate to the frontend running at `http://localhost:3000` (or the production URL if deployed).
- You will see a dashboard displaying current weather conditions as well as the option to view historical data.

### 2. Real-Time Weather Data

- The dashboard updates weather data in real-time, pulling data from the Arduino sensors connected to your weather station.
- Key metrics displayed include:
    - **Temperature**
    - **Humidity**
    - **Dew Point**
    - **UV Index**
    - **Wind Speed & Direction**
    - **Pressure**
    - **Precipitation**
    - **Solar Radiation**

### 3. Historical Data

- Navigate to the **History** page from the main menu.
- Choose a date range to view weather trends and archived data, including charts for various metrics like temperature, wind, and humidity.

![Weather Station User Interface - History Page](https://raw.githubusercontent.com/miksrv/arduino-weather-station/main/client/public/images/history.jpg)

</div>

### 4. Customize Data Display

- You can customize the data display to show or hide specific sensors on the dashboard.
- For example, toggle between temperature readings, feels-like temperature, and dew point, or switch between solar energy and solar radiation.

### 5. Arduino Sensor Calibration

- For accurate readings, you may need to calibrate some sensors depending on your specific environment. Refer to the Arduino sketch in the `arduino/` folder to adjust the calibration values for sensors such as temperature or pressure.

### 6. Data Export

- Weather data can be exported from the **History** page in various formats (e.g., CSV) to analyze trends further.

### 7. System Maintenance

- The backend server running on PHP + CodeIgniter is responsible for handling incoming data from the Arduino sensors and storing it in a MySQL database. Ensure the backend is running to avoid data loss.
- The frontend is built with Next.js and provides a smooth interface to view, interact with, and analyze weather data.

### 8. Arduino Weather Station Features

- **Real-time Monitoring**: Monitor real-time weather conditions using connected sensors.
- **Historical Data**: Review weather history with customizable date ranges.
- **Graphical Visualizations**: View weather trends and patterns using interactive charts.
- **Sensor Readings**: Monitor multiple environmental factors, such as UV Index, wind speed, and solar radiation.

## CLI Commands & Cron Jobs

The backend exposes several `php spark` commands for pulling external weather data, computing aggregates, and maintaining the anomaly log. These are intended to be scheduled via cron on the server running the PHP backend.

### Available Commands

| Command | Description |
|---|---|
| `php spark system:getCurrentWeather` | Fetches current weather observations from all configured external APIs (VisualCrossing, WeatherAPI, OpenWeatherMap, Open-Meteo), saves new records to `raw_weather_data`, and recalculates hourly and daily averages. |
| `php spark system:getForecastWeather` | Fetches forecast data from all configured external APIs and bulk-upserts records into `forecast_weather_data`. |
| `php spark system:sendNarodmonData` | Retrieves the latest sensor reading from the database and pushes it to the [narodmon.ru](https://narodmon.ru) monitoring service. |
| `php spark system:detectAnomalies` | Runs all meteorological anomaly checks against today's daily and hourly data and updates the `anomaly_log` table. Must run after daily averages are available. |
| `php spark system:backfillAnomalyLog` | Iterates all historical daily records and populates `anomaly_log` from scratch. Intended for initial bootstrapping. Accepts `--force` to bypass the non-empty table guard. |

### Recommended Schedule

| Command | Frequency | Rationale |
|---|---|---|
| `system:getCurrentWeather` | Every hour | Keeps raw observations and hourly/daily averages up to date. |
| `system:getForecastWeather` | Every 3–6 hours | Forecast data changes slowly; 4-hour intervals balance freshness against API quota. |
| `system:sendNarodmonData` | Every 15 minutes | Near-real-time push to the public monitoring network. |
| `system:detectAnomalies` | Once daily (e.g. 01:30) | Runs after midnight when the previous day's daily averages are fully computed. |
| `system:backfillAnomalyLog` | One-time / manual | Run once on a fresh deployment to seed historical anomaly records. |

### Example Crontab

Add the entries below to your server's crontab (`crontab -e`). Adjust `/var/www/project/server` to match your actual deployment path.

```cron
# Fetch current weather from external APIs and recalculate averages — every hour
0 * * * * cd /var/www/project/server && php spark system:getCurrentWeather >> /var/log/weather.log 2>&1

# Fetch forecast data — every 4 hours
0 */4 * * * cd /var/www/project/server && php spark system:getForecastWeather >> /var/log/weather.log 2>&1

# Push latest reading to narodmon.ru — every 15 minutes
*/15 * * * * cd /var/www/project/server && php spark system:sendNarodmonData >> /var/log/weather.log 2>&1

# Run anomaly detection — daily at 01:30 (after daily averages are ready)
30 1 * * * cd /var/www/project/server && php spark system:detectAnomalies >> /var/log/weather.log 2>&1
```

> **Note:** `system:backfillAnomalyLog` is a one-time maintenance command and should not be added to cron. Run it manually once after a fresh deployment:
> ```bash
> cd /var/www/project/server && php spark system:backfillAnomalyLog
> ```

## Screenshots and Demos

#### 1. **Current Weather Overview**

The **Current** section provides real-time data on the current weather conditions, including temperature, humidity, UV index, and more. Users can quickly view all key environmental metrics at a glance.

![Current Weather Interface](https://raw.githubusercontent.com/miksrv/arduino-weather-station/main/client/public/images/main.jpg)

#### 2. **Sensors Dashboard**

The **Sensors** section displays a list of all connected weather sensors, including temperature, pressure, wind speed, and solar radiation. This section gives users an in-depth view of each sensor's status and real-time readings.

![Sensors Dashboard](https://raw.githubusercontent.com/miksrv/arduino-weather-station/main/client/public/images/sensors.jpg)

#### 3. **Weather History and Trends**

The **History** section allows users to explore weather data over a specified time period. Interactive charts provide insights into trends for various weather metrics like temperature, wind speed, and humidity.

![History Interface](https://raw.githubusercontent.com/miksrv/arduino-weather-station/main/client/public/images/history.jpg)

#### 4. **Forecast**

The **Forecast** section offers a comprehensive weather outlook for the next five days, accompanied by a detailed breakdown for the current day. Users can access forecasts for temperature, precipitation, wind speed, humidity, and more, presented in an intuitive interface. This section is designed to help users plan their activities with precision by providing accurate, easy-to-read weather data for both short-term and extended periods.

![History Interface](https://raw.githubusercontent.com/miksrv/arduino-weather-station/main/client/public/images/forecast.jpg)

#### 5. **Heatmap**

The **Heatmap** section provides a detailed visualization of weather metrics, including temperature, pressure, humidity, precipitation, and cloud coverage, displayed as a heatmap. Users can select any time period to view trends and patterns across multiple environmental factors at once. This powerful tool allows for quick comparison and in-depth analysis of weather conditions over time.

![History Interface](https://raw.githubusercontent.com/miksrv/arduino-weather-station/main/client/public/images/heatmap.jpg)

#### 6. **Climate Dashboard**

The **Climate** page is a multi-widget climate science dashboard that surfaces long-term environmental trends from the station's full historical record. Five visualizations make warming and precipitation shifts immediately legible:

| Widget | Description |
|---|---|
| **Warming Stripes** | One color-coded stripe per year — deep blue (cold years) through white (baseline) to deep red (warm years). Inspired by Ed Hawkins' iconic "Show Your Stripes" graphic. |
| **Temperature Anomaly** | Bar chart of annual deviation from the long-term mean. Red bars = warmer than average, blue = cooler. A linear trend line is overlaid automatically. |
| **Monthly Climate Normals** | Band chart showing the all-time min/max envelope and historical mean per calendar month, with the current year's actual values overlaid. |
| **Annual Precipitation** | Yearly total rainfall bars (blue = above average, amber = below average) plus a linear trend line and a plain-language trend label. |
| **Extreme Event Days** | Grouped bars counting frost days (< 0 °C), hot days (≥ 30 °C), and heavy-rain days (≥ 10 mm) per year. |

All five widgets are powered by the new `GET /climate` endpoint, which returns pre-aggregated statistics computed server-side from `daily_averages`. The response is cached indefinitely (TTL = 0) because the underlying data changes at most once per year.

#### Live Demo

Explore the fully functioning weather station web application at:  
🌐 [Live Demo](https://meteo.miksoft.pro/en)

## Contributing

Contributions are what make the open-source community an incredible environment for learning, inspiration, and innovation. Your contributions are highly valued and greatly appreciated, whether it’s reporting bugs, suggesting improvements, or creating new features.

**To contribute:**

1. Fork the project by clicking the "Fork" button at the top of this page.
2. Clone your fork locally:
   ```bash
   git clone https://github.com/miksrv/arduino-weather-station.git
   ```
3. Create a new feature branch:
   ```bash
   git checkout -b feature/AmazingFeature
   ```
4. Make your changes, then commit them:
   ```bash
   git commit -m "Add AmazingFeature"
   ```
5. Push your changes to your forked repository:
   ```bash
   git push origin feature/AmazingFeature
   ```
6. Open a pull request from your feature branch to the main repository.

We encourage contributions of all kinds, whether big or small. Your efforts help improve the project for everyone!

## License

Distributed under the MIT License. See [LICENSE](LICENSE) for more information.

## Acknowledgments

This section is dedicated to recognizing the resources and individuals that have been invaluable to this project. I’d like to highlight a few key tools and contributions that made a significant impact on its development. Feel free to explore them as they may be useful for your own projects!

1. [CodeIgniter](https://codeigniter.com/user_guide/helpers/date_helper.html)
2. [Simple React UI](https://github.com/miksrv/simple-react-ui-kit)
3. [Weather Icons](https://erikflowers.github.io/weather-icons/)
4. [Meteocons](https://bas.dev/work/meteocons)

## Contact

Misha - [miksoft.pro](https://miksoft.pro)

[contributors-badge]: https://img.shields.io/github/contributors/miksrv/arduino-weather-station.svg?style=for-the-badge
[contributors-url]: https://github.com/miksrv/arduino-weather-station/graphs/contributors
[forks-badge]: https://img.shields.io/github/forks/miksrv/arduino-weather-station.svg?style=for-the-badge
[forks-url]: https://github.com/miksrv/arduino-weather-station/network/members
[stars-badge]: https://img.shields.io/github/stars/miksrv/arduino-weather-station.svg?style=for-the-badge
[stars-url]: https://github.com/miksrv/arduino-weather-station/stargazers
[issues-badge]: https://img.shields.io/github/issues/miksrv/arduino-weather-station.svg?style=for-the-badge
[issues-url]: https://github.com/miksrv/arduino-weather-station/issues
[license-badge]: https://img.shields.io/github/license/miksrv/arduino-weather-station.svg?style=for-the-badge
[license-url]: https://github.com/miksrv/arduino-weather-station/blob/master/LICENSE.txt

[js-badge]: https://img.shields.io/badge/JavaScript-F7DF1E?logo=javascript&logoColor=000
[js-url]: https://www.javascript.com/
[ts-badge]: https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=fff
[ts-url]: https://www.typescriptlang.org/
[nextjs-badge]: https://img.shields.io/badge/Next.js-black?logo=next.js&logoColor=white
[nextjs-url]: https://nextjs.org/
[nodejs-badge]: https://img.shields.io/badge/Node.js-6DA55F?logo=node.js&logoColor=white
[nodejs-url]: https://nodejs.org/
[redux-badge]: https://img.shields.io/badge/Redux-764ABC?logo=redux&logoColor=fff
[redux-url]: https://redux.js.org/
[sass-badge]: https://img.shields.io/badge/Sass-C69?logo=sass&logoColor=fff
[sass-url]: https://sass-lang.com/
[c++-badge]: https://img.shields.io/badge/C++-%2300599C.svg?logo=c%2B%2B&logoColor=white
[c++-url]: https://cplusplus.com/
[php-badge]: https://img.shields.io/badge/php-%23777BB4.svg?&logo=php&logoColor=white
[php-url]: https://www.php.net/
[mysql-badge]: https://img.shields.io/badge/MySQL-4479A1?logo=mysql&logoColor=fff
[mysql-url]: https://www.mysql.com/
[sonarcloud-badge]: https://img.shields.io/badge/SonarCloud-F3702A?logo=sonarcloud&logoColor=fff
[sonarcloud-url]: https://sonarcloud.io/
[githubactions-badge]: https://img.shields.io/badge/GitHub_Actions-2088FF?logo=github-actions&logoColor=white
[githubactions-url]: https://docs.github.com/en/actions

arduino-weather-station

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README