From 069fb7070d68116dd4a6d7d347c1cc14ab0eaf1b Mon Sep 17 00:00:00 2001 From: scayac Date: Sun, 25 May 2025 08:31:43 +0200 Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1c011ed..3c44099 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@ # Joulemetre Viewer ## Overview + The Joulemetre Viewer is a web application designed to display real-time data read from a serial port. It visualizes key electrical parameters including power, voltage, current, energy, and time. The application utilizes WebSockets for live updates, ensuring that users receive the most current data without needing to refresh the page. +## Versions + +Node.JS version : 18.19.1 + ## Project Structure + ``` joulemetre-viewer ├── src @@ -21,32 +27,36 @@ joulemetre-viewer ``` ## Installation + 1. Clone the repository: + ``` git clone cd joulemetre-viewer ``` 2. Install the dependencies: + ``` npm install ``` +3. Upload the .hex file in the arduino_hex folder to the arduino board. + ## Usage + 1. Start the server: + ``` npm start ``` + + If you want to use another serial port (COM3 for example), the command is : + + ``` + npm start COM3 + ``` 2. Open your web browser and navigate to `http://localhost:3000` to view the application. -## Features -- Real-time data display from a serial port. -- WebSocket communication for live updates. -- User-friendly interface for monitoring electrical parameters. - -## Contributing -Contributions are welcome! Please submit a pull request or open an issue for any enhancements or bug fixes. - -## License -This project is licensed under the MIT License. \ No newline at end of file +#