Skip to content

Commit

Permalink
feat(Readme): init
Browse files Browse the repository at this point in the history
  • Loading branch information
atbore-phx committed Mar 3, 2024
1 parent 5e59e97 commit 80a8fbb
Showing 1 changed file with 75 additions and 0 deletions.
75 changes: 75 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# sbam - Smart Battery Avanced Management.

## Intro

Charge Fronius battery using SolCast weather forecast.

``` bash
sbam - Smart Battery Avanced Management.
Charge Fronius© battery using weather forecast.
Initiate parameters from command line, env variables or config.yaml file.

Usage:
sbam [command]

Available Commands:
completion Generate the autocompletion script for the specified shell
configure Configure Battery Storage Charge
estimate Estimate Forecast Solar Power
help Help about any command
schedule Schedule Battery Storage Charge

Flags:
-h, --help help for sbam
-v, --version version for sbam

Use "sbam [command] --help" for more information about a command.
```
## Configure

Connect to the fronius inverter via modbus and set charging

``` bash
Usage:
sbam configure [flags]

Flags:
-d, --defaults Set defaults
-f, --force-charge Force charge
-H, --fronius_ip string FRONIUS_IP
-h, --help help for configure
-p, --power int16 Power (percent of nominal power)
```

## Estimate
Print the solar forecast and the battery storage power

``` bash
Usage:
sbam estimate [flags]

Flags:
-k, --apikey string APIKEY
-H, --fronius_ip string FRONIUS_IP
-h, --help help for estimate
-u, --url string URL
```

## Schedule
Workflow to Check Forecast and Battery residual Capacity and decide if it has to be charged in a definited time range.

``` bash
Usage:
sbam schedule [flags]

Flags:
-k, --apikey string APIKEY
-e, --end_hr string END_HR (default "06:00")
-H, --fronius_ip string FRONIUS_IP
-h, --help help for schedule
-m, --max_charge int MAX_CHARGE (default 3500)
-c, --pw_consumption float PW_CONSUMPTION
-s, --start_hr string START_HR (default "00:00")
-u, --url string URL

```

0 comments on commit 80a8fbb

Please sign in to comment.