Skip to content

Commit

Permalink
docs: updated readme to reflect latest changes
Browse files Browse the repository at this point in the history
  • Loading branch information
stefa168 committed Nov 21, 2023
1 parent e32b8dc commit 7d052e5
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ services:
- "5279:5279/tcp"
volumes:
- ./inverters:/usr/local/bin/inverters
- config.yaml:/usr/local/bin/config.yaml
environment:
LOG_LEVEL: INFO
```

---
Expand All @@ -104,9 +107,17 @@ Please note that the `inverters` folder is mandatory, and must contain the (curr
<!-- USAGE EXAMPLES -->
## Usage

Right now it is sufficient to run the executable, or start the container.
To start the server it is simply a matter of running the executable.
By default, it looks for a configuration file in the same directory, however it can be changed with the `-c` or `--config_path` optional parameter.

Please note that currently the server does not relay the data to anything else except Growatt's servers on `server.growatt.com`.
Please take a look at the default [configuration file for more information](config.yaml). (Soon they will be listed here too)

If a log level different from `INFO` is necessary, set the environment variable `LOG_LEVEL` to the required level (`DEBUG`, `TRACE`, etc.)

The server will relay data to the endpoint specified in the configuration file.
It defaults to Growatt's servers on `server.growatt.com`.
For more command-line options, use the `--help` option.
<!-- ROADMAP -->
## Roadmap
Expand All @@ -120,7 +131,7 @@ Please note that currently the server does not relay the data to anything else e
- [x] Protocol v6
- [ ] ?
- [ ] Data
- [ ] Storage
- [x] Storage
- [ ] MQTT
- [ ] Home Assistant
- [ ] Frontend
Expand Down
3 changes: 0 additions & 3 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,6 @@ async fn main() -> Result<()> {
let config_path: &String = args.get_one("config_path").unwrap();
info!("Loading configuration from `{}`", config_path);

// let span = tracing::span!(tracing::Level::ERROR, "startup");
// let _enter = span.enter();

let config = config::load_from_yaml(config_path)
.await
.expect_or_log("Failed to load the configuration file");
Expand Down

0 comments on commit 7d052e5

Please sign in to comment.