ETA to Ecowitt Weather Station Connector

A Next.js 15 application for connecting ETA and Ecowitt Weather Station to provide real-time temperature information for both indoor and outdoor temperatures, ETA system data, and control the ETA heating system.

Connects the temperature sensors of an Ecowitt weather station with an ETA heating system and takes over the temperature control of the heating system. Thus replaces an ETA room thermostat.

This project was developed using Windsurf, an advanced AI-powered development environment. The entire codebase was programmed through pair programming with Claude 3.5 Sonnet, making it a showcase of modern AI-assisted development.

Visit Windsurf at https://codeium.com/windsurf

Connect with Codeium:

Twitter: https://twitter.com/codeiumdev
Discord: https://discord.gg/3XFf78nAx5
LinkedIn: https://www.linkedin.com/company/codeium
GitHub: https://github.com/Exafunction/codeium

Features

Real-time System Monitoring
- Live ETA heating system data display
- Weather station temperature readings
- Background synchronization of data
Advanced Configuration
- Comprehensive system parameter management
- Name-to-ID mapping functionality
- Configurable update intervals
User Interface
- Modern, responsive design with Tailwind CSS
- Tab-based navigation system
- Interactive header with menu navigation
- Detailed logging interface
Data Management
- Redux-based state management
- Efficient background data synchronization
- Type-safe data handling with TypeScript
Interactive Charts
- Real-time visualization of temperature and humidity data
- Responsive Chart.js integration with zoom functionality
- Custom styling with Geist Mono font
- Multiple chart views:
  - Main chart (temperature, pressure, humidity)
  - Channel temperature chart
  - Channel humidity chart
- Interactive features:
  - Zoom reset functionality
  - Custom tooltips with formatted timestamps
  - Zero line indicators for temperature charts
Performance Optimization
- Client-side only chart rendering to prevent SSR issues
- Memory leak prevention through:
  - Proper cleanup of chart instances
  - Dynamic imports for heavy components
  - Efficient data structure management
- TypeScript for enhanced type safety
Logging System
- Organized log files by type and date
- Interactive log viewer interface
- Filterable log categories
- Accessible via dedicated /logs route
API Integration
- ETA heating system API integration
- Weather station (WifiAf83) data retrieval
- Real-time data updates

Technical Details

Framework: Next.js 15 with TypeScript
State Management: Redux with @reduxjs/toolkit
UI Components: React 19.0.0-rc.1
Styling: Tailwind CSS
Server: Custom Node.js server with background services
Development:
- TypeScript for type safety
- ESLint for code quality
- Cross-env for environment management

Project Structure

eta2weather.nextjs/
├── src/
│   ├── app/                    # Next.js app pages
│   │   ├── page.tsx           # Main application page
│   │   ├── logs/              # Logging functionality
│   │   └── layout.tsx         # App layout component
│   ├── components/            # React components
│   │   ├── BackgroundSync.tsx # Background data sync
│   │   ├── ConfigData.tsx     # Configuration display
│   │   ├── EtaData.tsx       # ETA system data
│   │   ├── Header.tsx        # App header with navigation
│   │   ├── MenuPopup.tsx     # Navigation menu
│   │   ├── Names2IdData.tsx  # Name mapping component
│   │   ├── StoreProvider.tsx # Redux store provider
│   │   └── WifiAf83Data.tsx  # Weather station data
│   ├── reader/               # Data processing & API
│   │   └── functions/
│   │       ├── EtaApi.tsx    # ETA system API
│   │       ├── SetEta.tsx    # ETA control functions
│   │       ├── WifiAf83Api.tsx # Weather station API
│   │       └── types-constants/ # Type definitions
│   └── redux/                # State management
│       ├── configSlice.tsx   # Configuration state
│       ├── dataSlice.tsx     # Data management
│       ├── etaSlice.tsx      # ETA system state
│       └── wifiAf83Slice.tsx # Weather data state

Setup and Installation

Clone the repository

Create .env file from example:

cp .env.example .env

Update the server address in .env:

DEFAULT_CONFIG_FILE='./config/f_etacfg.json'
DEFAULT_SERVER='192.x.x.x:8080'  # Replace with your server address

Configure Ecowitt API (if using weather station):

cp eco.example.tsx eco.ts

Update with your Ecowitt credentials:

config: {
  applicationKey: "XXX", // From Ecowitt API Settings
  apiKey: "XXX",        // Generated API Key
  mac: "XXX",           // Device MAC Address
  server: "api.ecowitt.net"
}

See eco.example.ts for detailed instructions on obtaining API credentials.

Install dependencies:
```
npm install
```
Run the development server:
```
npm run dev
```

API Documentation

Ecowitt API

The weather station data is retrieved using the Ecowitt API v3. For detailed information about the API endpoints and parameters, refer to the official Ecowitt API documentation.

ETA API

The heating system data is managed through the ETA RESTful API. For comprehensive documentation about the available endpoints and their usage, see the ETA RESTful API documentation.

Development

API Endpoints

Read Endpoints

/api/config/read: Retrieves the current configuration data.
/api/eta/read: Retrieves the ETA system data.
/api/wifiaf83/read: Retrieves the weather and temperature data.
/api/names2id/read: Retrieves the names to ID mapping data.

Update Endpoints

/api/config/update: Updates configuration values
```
// POST request
{
  "key": string,   // One of the ConfigKeys values
  "value": string  // New value for the config key
}
```
Available config keys:
- t_soll: Target temperature (default: "22")
- t_delta: Temperature delta (default: "0")
- t_slider: Slider position (default: "0.0")
- f_eta: ETA configuration file (default: "f_eta.json")
- s_eta: ETA server address (default: "192.168.8.100:8080")
- f_wifiaf83: WiFi sensor config file (default: "f_wifiaf89.json")
- f_names2id: Names to ID mapping file (default: "f_names2id.json")
- t_update_timer: Update interval in ms (default: "300000")
- diff: Temperature difference (default: "0")
Response:
```
// Success (200 OK)
{
  ...updatedConfig // Full updated configuration object
}

// Error (400 Bad Request)
{
  "error": "Invalid config key" | "Value must be a string"
}

// Error (500 Internal Server Error)
{
  "error": "Internal Server Error",
  "message": string,
  "type": string
}
```

Component Structure

ConfigData: System configuration display
EtaData: ETA system data visualization
WifiAf83Data: Weather information display

Styling

Consistent table widths (400px)
Fixed column sizes (250px + 150px)
Responsive grid layout
Monospace fonts for values
Right-aligned numeric data

Docker Usage

Prerequisites

Configure the environment file:

cp .env.example .env

Update the .env file with your settings:

DEFAULT_CONFIG_FILE='./config/f_etacfg.json'
DEFAULT_SERVER='192.x.x.x:8080'  # Your ETA server address

Configure Ecowitt settings:

cp eco.example.tsx eco.tsx

Update eco.tsx with your Ecowitt credentials:

config: {
  applicationKey: "XXX", // From Ecowitt API Settings
  apiKey: "XXX",        // Your generated API Key
  mac: "XXX",           // Your device MAC Address
  server: "api.ecowitt.net"
}

Running with Docker

You can run this application using Docker in two ways:

Using Docker Directly

Build the Docker image:
```
docker build -t eta2weather .
```
Run the container:
```
docker run -p 3000:3000 eta2weather
```

Using Docker Compose

Build and start the container:
```
docker-compose up -d
```
Stop the container:
```
docker-compose down
```

The application will be available at http://localhost:3000.

Note: The Docker build process will include your configured .env and eco.tsx files in the image. Make sure these files are properly configured before building the image.

Recent Updates

UI Improvements (Latest)

Added shadow effects to data cards for better visual hierarchy
Improved grid layout with 3-column design for better data organization
Updated spacing and padding for better visual consistency
Reordered WiFi data categories to show channels after indoor data
Added rounded corners and shadow effects to improve visual appeal

API Integration

Migrated API routes from Next.js Pages Router (pages/api/*) to App Router (app/api/*)
- Updated route handlers to use new App Router conventions
- Improved error handling and response formatting
- Enhanced type safety with TypeScript
Improved error handling in API responses
Enhanced data fetching reliability for both ETA and WiFi data

Component Updates

WifiTab:
- Optimized grid layout (2 columns on mobile, 3 columns on larger screens)
- Enhanced card styling with shadow effects
- Improved data organization with logical category ordering
EtaTab:
- Improved spacing with consistent padding
- Enhanced visual hierarchy with shadow effects
- Better background contrast for improved readability

Configuration

Updated configuration handling to support new API parameters
Improved error handling for configuration loading

Automatic Startup with systemd

A systemd service file is provided in the linux directory to automatically start the application on system boot.

To set up automatic startup:

Copy the service file to systemd:

sudo cp linux/docker-compose-app.service /etc/systemd/system/

Reload the systemd daemon:

sudo systemctl daemon-reload

Enable the service to start on boot:

sudo systemctl enable docker-compose-app.service

Start the service immediately (optional):

sudo systemctl start docker-compose-app.service

You can check the status of the service at any time with:

sudo systemctl status docker-compose-app.service

Automatic Startup on Windows

A PowerShell script is provided in the windows directory to set up the application as a Windows service using NSSM (Non-Sucking Service Manager).

Prerequisites

Install NSSM:
- Download NSSM from https://nssm.cc/download
- Extract the appropriate version (32/64 bit) to C:\nssm
- Add C:\nssm to your system's PATH environment variable
Ensure Docker Desktop is installed and set to start with Windows

Installation

Open PowerShell as Administrator
Navigate to the project's windows directory:

cd path\to\project\windows

Run the installation script:

.\install-service.ps1

Start the service:

Start-Service DockerComposeETA

Managing the Service

Check service status:

Get-Service DockerComposeETA

Stop the service:

Stop-Service DockerComposeETA

Uninstall the service:

.\uninstall-service.ps1

The service is configured to start automatically with Windows and will manage the Docker Compose application lifecycle.

Automatic Startup on macOS

The application can be configured to start automatically on macOS using a Launch Agent. Installation scripts are provided in the osx directory.

Prerequisites

Ensure Docker Desktop for Mac is installed and configured to start at login
Make sure docker-compose is installed and available at /usr/local/bin/docker-compose

Installation

Open Terminal and navigate to the project's osx directory:

cd path/to/project/osx

Make the scripts executable:

chmod +x install.sh uninstall.sh

Run the installation script:

./install.sh

The service will start automatically and will be configured to launch on login.

Managing the Service

Check if the service is running:

launchctl list | grep com.etaweather.docker-compose

Stop the service:

launchctl unload ~/Library/LaunchAgents/com.etaweather.docker-compose.plist

Start the service:

launchctl load ~/Library/LaunchAgents/com.etaweather.docker-compose.plist

View logs:

tail -f ~/Library/Logs/etaweather-docker-compose.log
tail -f ~/Library/Logs/etaweather-docker-compose.err

Uninstall the service:

./uninstall.sh

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Name		Name	Last commit message	Last commit date
Latest commit History 143 Commits
linux		linux
osx		osx
public		public
src		src
windows		windows
.env.example		.env.example
.env.local		.env.local
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
docker-compose.yml		docker-compose.yml
eco.example.ts		eco.example.ts
next.config.mjs		next.config.mjs
package-lock.json		package-lock.json
package.json		package.json
postcss.config.mjs		postcss.config.mjs
server.ts		server.ts
tailwind.config.ts		tailwind.config.ts
tsconfig.json		tsconfig.json

License

jeamy/eta2weather.nextjs15

Folders and files

Latest commit

History

Repository files navigation

ETA to Ecowitt Weather Station Connector

Features

Technical Details

Project Structure

Setup and Installation

API Documentation

Ecowitt API

ETA API

Development

API Endpoints

Read Endpoints

Update Endpoints

Component Structure

Styling

Docker Usage

Prerequisites

Running with Docker

Using Docker Directly

Using Docker Compose

Recent Updates

UI Improvements (Latest)

API Integration

Component Updates

Configuration

Automatic Startup with systemd

Automatic Startup on Windows

Prerequisites

Installation

Managing the Service

Automatic Startup on macOS

Prerequisites

Installation

Managing the Service

License

About

Topics

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages