Skip to content

Commit db7e6ce

Browse files
naltatisnaltatis
committed
update cli docs
1 parent 9033f56 commit db7e6ce

10 files changed

Lines changed: 281 additions & 0 deletions

‎src/content/docs/en/reference/cli/evcc.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ evcc [flags]
3737
- [evcc device](evcc_device.md) - Query database-configured devices (debug only)
3838
- [evcc discuss](evcc_discuss.md) - Request support at Github Discussions (https://github.com/evcc-io/evcc/discussions/categories/erste-hilfe)
3939
- [evcc dump](evcc_dump.md) - Dump configuration
40+
- [evcc easee-ocpp](evcc_easee-ocpp.md) - Manage Easee local OCPP configuration
4041
- [evcc meter](evcc_meter.md) - Query configured meters
42+
- [evcc metrics](evcc_metrics.md) - Inspect stored energy metrics
4143
- [evcc migrate](evcc_migrate.md) - Migrate yaml to database (deprecated), reset only
4244
- [evcc password](evcc_password.md) - Password administration
4345
- [evcc settings](evcc_settings.md) - Manage configuration settings

‎src/content/docs/en/reference/cli/evcc_easee-ocpp.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "evcc easee-ocpp"
3+
---
4+
5+
Manage Easee local OCPP configuration
6+
7+
## Options
8+
9+
```
10+
--charger string Easee charger serial number
11+
--password string Easee account password
12+
--user string Easee account email
13+
```
14+
15+
## Options inherited from parent commands
16+
17+
```
18+
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
19+
--database string Database location (default "~/.evcc/evcc.db")
20+
-h, --help Help
21+
--ignore-db Run command ignoring service database
22+
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
23+
--log-headers Log headers
24+
```
25+
26+
## See also
27+
28+
- [evcc](evcc.md) - evcc - open source solar charging
29+
- [evcc easee-ocpp disable](evcc_easee-ocpp_disable.md) - Disable local OCPP on Easee charger
30+
- [evcc easee-ocpp enable](evcc_easee-ocpp_enable.md) - Enable local OCPP on Easee charger
31+
- [evcc easee-ocpp status](evcc_easee-ocpp_status.md) - Show Easee local OCPP configuration

‎src/content/docs/en/reference/cli/evcc_easee-ocpp_disable.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: "evcc easee-ocpp disable"
3+
---
4+
5+
Disable local OCPP on Easee charger
6+
7+
```
8+
evcc easee-ocpp disable [flags]
9+
```
10+
11+
## Options inherited from parent commands
12+
13+
```
14+
--charger string Easee charger serial number
15+
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
16+
--database string Database location (default "~/.evcc/evcc.db")
17+
-h, --help Help
18+
--ignore-db Run command ignoring service database
19+
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
20+
--log-headers Log headers
21+
--password string Easee account password
22+
--user string Easee account email
23+
```
24+
25+
## See also
26+
27+
- [evcc easee-ocpp](evcc_easee-ocpp.md) - Manage Easee local OCPP configuration

‎src/content/docs/en/reference/cli/evcc_easee-ocpp_enable.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: "evcc easee-ocpp enable"
3+
---
4+
5+
Enable local OCPP on Easee charger
6+
7+
```
8+
evcc easee-ocpp enable [flags]
9+
```
10+
11+
## Options
12+
13+
```
14+
--url string OCPP Central System URL (e.g. ws://192.168.1.100:8887/)
15+
```
16+
17+
## Options inherited from parent commands
18+
19+
```
20+
--charger string Easee charger serial number
21+
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
22+
--database string Database location (default "~/.evcc/evcc.db")
23+
-h, --help Help
24+
--ignore-db Run command ignoring service database
25+
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
26+
--log-headers Log headers
27+
--password string Easee account password
28+
--user string Easee account email
29+
```
30+
31+
## See also
32+
33+
- [evcc easee-ocpp](evcc_easee-ocpp.md) - Manage Easee local OCPP configuration

‎src/content/docs/en/reference/cli/evcc_easee-ocpp_status.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: "evcc easee-ocpp status"
3+
---
4+
5+
Show Easee local OCPP configuration
6+
7+
```
8+
evcc easee-ocpp status [flags]
9+
```
10+
11+
## Options inherited from parent commands
12+
13+
```
14+
--charger string Easee charger serial number
15+
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
16+
--database string Database location (default "~/.evcc/evcc.db")
17+
-h, --help Help
18+
--ignore-db Run command ignoring service database
19+
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
20+
--log-headers Log headers
21+
--password string Easee account password
22+
--user string Easee account email
23+
```
24+
25+
## See also
26+
27+
- [evcc easee-ocpp](evcc_easee-ocpp.md) - Manage Easee local OCPP configuration

‎src/content/docs/en/reference/cli/evcc_metrics.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "evcc metrics"
3+
---
4+
5+
Inspect stored energy metrics
6+
7+
## Options inherited from parent commands
8+
9+
```
10+
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
11+
--database string Database location (default "~/.evcc/evcc.db")
12+
-h, --help Help
13+
--ignore-db Run command ignoring service database
14+
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
15+
--log-headers Log headers
16+
```
17+
18+
## See also
19+
20+
- [evcc](evcc.md) - evcc - open source solar charging
21+
- [evcc metrics battery](evcc_metrics_battery.md) - Compare battery charge and discharge energy
22+
- [evcc metrics data](evcc_metrics_data.md) - Export energy data as a table
23+
- [evcc metrics entities](evcc_metrics_entities.md) - List metric entities
24+
- [evcc metrics forecast](evcc_metrics_forecast.md) - Compare solar forecast against actual PV production

‎src/content/docs/en/reference/cli/evcc_metrics_battery.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: "evcc metrics battery"
3+
---
4+
5+
Compare battery charge and discharge energy
6+
7+
## Synopsis
8+
9+
Compare charge and discharge energy per battery.
10+
11+
Without arguments all batteries are compared for the current day. Batteries can
12+
be selected by name or title.
13+
14+
```
15+
evcc metrics battery [name ...] [flags]
16+
```
17+
18+
## Options
19+
20+
```
21+
--from string Start date as YYYY-MM-DD (default today)
22+
--range string Quick timeframe: day, month or year
23+
--to string End date as YYYY-MM-DD, inclusive (default today)
24+
```
25+
26+
## Options inherited from parent commands
27+
28+
```
29+
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
30+
--database string Database location (default "~/.evcc/evcc.db")
31+
-h, --help Help
32+
--ignore-db Run command ignoring service database
33+
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
34+
--log-headers Log headers
35+
```
36+
37+
## See also
38+
39+
- [evcc metrics](evcc_metrics.md) - Inspect stored energy metrics

‎src/content/docs/en/reference/cli/evcc_metrics_data.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: "evcc metrics data"
3+
---
4+
5+
Export energy data as a table
6+
7+
## Synopsis
8+
9+
Export aggregated energy data as a table.
10+
11+
Without arguments all entities are exported for the current day. Entities can be
12+
selected by name or title; run the entities subcommand to list them.
13+
14+
```
15+
evcc metrics data [entity ...] [flags]
16+
```
17+
18+
## Options
19+
20+
```
21+
--aggregate string Aggregation interval: 15m, hour, day or month (default "hour")
22+
--csv Output CSV instead of a table
23+
--from string Start date as YYYY-MM-DD (default today)
24+
--group string Limit output to an entity group
25+
--range string Quick timeframe: day, month or year
26+
--to string End date as YYYY-MM-DD, inclusive (default today)
27+
```
28+
29+
## Options inherited from parent commands
30+
31+
```
32+
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
33+
--database string Database location (default "~/.evcc/evcc.db")
34+
-h, --help Help
35+
--ignore-db Run command ignoring service database
36+
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
37+
--log-headers Log headers
38+
```
39+
40+
## See also
41+
42+
- [evcc metrics](evcc_metrics.md) - Inspect stored energy metrics

‎src/content/docs/en/reference/cli/evcc_metrics_entities.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "evcc metrics entities"
3+
---
4+
5+
List metric entities
6+
7+
```
8+
evcc metrics entities [flags]
9+
```
10+
11+
## Options inherited from parent commands
12+
13+
```
14+
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
15+
--database string Database location (default "~/.evcc/evcc.db")
16+
-h, --help Help
17+
--ignore-db Run command ignoring service database
18+
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
19+
--log-headers Log headers
20+
```
21+
22+
## See also
23+
24+
- [evcc metrics](evcc_metrics.md) - Inspect stored energy metrics

‎src/content/docs/en/reference/cli/evcc_metrics_forecast.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "evcc metrics forecast"
3+
---
4+
5+
Compare solar forecast against actual PV production
6+
7+
```
8+
evcc metrics forecast [flags]
9+
```
10+
11+
## Options
12+
13+
```
14+
--from string Start date as YYYY-MM-DD (default today)
15+
--range string Quick timeframe: day, month or year
16+
--to string End date as YYYY-MM-DD, inclusive (default today)
17+
```
18+
19+
## Options inherited from parent commands
20+
21+
```
22+
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
23+
--database string Database location (default "~/.evcc/evcc.db")
24+
-h, --help Help
25+
--ignore-db Run command ignoring service database
26+
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
27+
--log-headers Log headers
28+
```
29+
30+
## See also
31+
32+
- [evcc metrics](evcc_metrics.md) - Inspect stored energy metrics

0 commit comments

Comments
 (0)