diff --git a/README.md b/README.md index d1c442b22..a8e916a4b 100644 --- a/README.md +++ b/README.md @@ -41,3 +41,13 @@ $ npm run build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. It should be run before any changes are committed, as it also includes link checking. + +### Update CLI docs + +CLI documentation is automatically generated. +Generation needs to be triggered manually. +Run this command inside the evcc core repository (e.g. `./evcc`). + +```sh +go run main.go gendoc ../evcc-docs/docs/reference/cli/ +``` diff --git a/docs/reference/cli/_category_.json b/docs/reference/cli/_category_.json new file mode 100644 index 000000000..dd6f3571b --- /dev/null +++ b/docs/reference/cli/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "CLI" +} \ No newline at end of file diff --git a/docs/reference/cli/evcc.md b/docs/reference/cli/evcc.md new file mode 100644 index 000000000..5a210fb20 --- /dev/null +++ b/docs/reference/cli/evcc.md @@ -0,0 +1,43 @@ +# evcc + +evcc - open source solar charging + +``` +evcc [flags] +``` + +## Options + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers + --metrics Expose metrics + --profile Expose pprof profiles +``` + +## See also + +* [evcc charger](evcc_charger.md) - Query configured chargers +* [evcc checkconfig](evcc_checkconfig.md) - Check config file for errors +* [evcc completion](evcc_completion.md) - Generate the autocompletion script for the specified shell +* [evcc configure](evcc_configure.md) - Create configuration (evcc.yaml) +* [evcc detect](evcc_detect.md) - Auto-detect compatible hardware +* [evcc device](evcc_device.md) - Query database-configured devices (debug only) +* [evcc discuss](evcc_discuss.md) - Request support at Github Discussions (https://github.com/evcc-io/evcc/discussions/categories/erste-hilfe) +* [evcc dump](evcc_dump.md) - Dump configuration +* [evcc eebus-cert](evcc_eebus-cert.md) - Generate EEBUS certificate for using EEBUS compatible chargers +* [evcc health](evcc_health.md) - Check application health +* [evcc meter](evcc_meter.md) - Query configured meters +* [evcc migrate](evcc_migrate.md) - Migrate yaml to database (overwrites db settings) +* [evcc password](evcc_password.md) - Password administration +* [evcc settings](evcc_settings.md) - Manage configuration settings +* [evcc sponsor](evcc_sponsor.md) - Validate sponsor token +* [evcc sunspec](evcc_sunspec.md) - Dump SunSpec model information +* [evcc tariff](evcc_tariff.md) - Query configured tariff +* [evcc token](evcc_token.md) - Generate token credentials +* [evcc vehicle](evcc_vehicle.md) - Query configured vehicles + + diff --git a/docs/reference/cli/evcc_charger.md b/docs/reference/cli/evcc_charger.md new file mode 100644 index 000000000..6ac67a2a8 --- /dev/null +++ b/docs/reference/cli/evcc_charger.md @@ -0,0 +1,35 @@ +# evcc charger + +Query configured chargers + +``` +evcc charger [name] [flags] +``` + +## Options + +``` + -i, --current float Set maximum current + --diagnose Diagnose + -d, --disable Disable + -e, --enable Enable + -p, --phases int Set usable phases (1 or 3) + -w, --wakeup Wake up +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging +* [evcc charger ramp](evcc_charger_ramp.md) - Ramp current from 6..16A in configurable steps + + diff --git a/docs/reference/cli/evcc_charger_ramp.md b/docs/reference/cli/evcc_charger_ramp.md new file mode 100644 index 000000000..e6e6dcd57 --- /dev/null +++ b/docs/reference/cli/evcc_charger_ramp.md @@ -0,0 +1,30 @@ +# evcc charger ramp + +Ramp current from 6..16A in configurable steps + +``` +evcc charger ramp [name] [flags] +``` + +## Options + +``` + --delay string ramp delay (default "1s") + --digits string fractional digits (0..2) (default "0") +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc charger](evcc_charger.md) - Query configured chargers + + diff --git a/docs/reference/cli/evcc_checkconfig.md b/docs/reference/cli/evcc_checkconfig.md new file mode 100644 index 000000000..e2dd24e8f --- /dev/null +++ b/docs/reference/cli/evcc_checkconfig.md @@ -0,0 +1,29 @@ +# evcc checkconfig + +Check config file for errors + +## Synopsis + +Check the (specified or default) config file for errors. Note that + checkconfig only checks the config file for parsing errors and does + not check that individual device configurations are valid. + +``` +evcc checkconfig [flags] +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_completion.md b/docs/reference/cli/evcc_completion.md new file mode 100644 index 000000000..e5d077ca0 --- /dev/null +++ b/docs/reference/cli/evcc_completion.md @@ -0,0 +1,29 @@ +# evcc completion + +Generate the autocompletion script for the specified shell + +## Synopsis + +Generate the autocompletion script for evcc for the specified shell. +See each sub-command's help for details on how to use the generated script. + + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging +* [evcc completion bash](evcc_completion_bash.md) - Generate the autocompletion script for bash +* [evcc completion fish](evcc_completion_fish.md) - Generate the autocompletion script for fish +* [evcc completion powershell](evcc_completion_powershell.md) - Generate the autocompletion script for powershell +* [evcc completion zsh](evcc_completion_zsh.md) - Generate the autocompletion script for zsh + + diff --git a/docs/reference/cli/evcc_completion_bash.md b/docs/reference/cli/evcc_completion_bash.md new file mode 100644 index 000000000..fe13bf1c2 --- /dev/null +++ b/docs/reference/cli/evcc_completion_bash.md @@ -0,0 +1,59 @@ +# evcc completion bash + +Generate the autocompletion script for bash + +## Synopsis + +Generate the autocompletion script for the bash shell. + +This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager. + +To load completions in your current shell session: + +``` +source <(evcc completion bash) +``` + +To load completions for every new session, execute once: + +### Linux: + +``` +evcc completion bash > /etc/bash_completion.d/evcc +``` + +### macOS: + +``` +evcc completion bash > $(brew --prefix)/etc/bash_completion.d/evcc +``` + +You will need to start a new shell for this setup to take effect. + + +``` +evcc completion bash +``` + +## Options + +``` + --no-descriptions disable completion descriptions +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc completion](evcc_completion.md) - Generate the autocompletion script for the specified shell + + diff --git a/docs/reference/cli/evcc_completion_fish.md b/docs/reference/cli/evcc_completion_fish.md new file mode 100644 index 000000000..2e9bfe39d --- /dev/null +++ b/docs/reference/cli/evcc_completion_fish.md @@ -0,0 +1,48 @@ +# evcc completion fish + +Generate the autocompletion script for fish + +## Synopsis + +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: + +``` +evcc completion fish | source +``` + +To load completions for every new session, execute once: + +``` +evcc completion fish > ~/.config/fish/completions/evcc.fish +``` + +You will need to start a new shell for this setup to take effect. + + +``` +evcc completion fish [flags] +``` + +## Options + +``` + --no-descriptions disable completion descriptions +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc completion](evcc_completion.md) - Generate the autocompletion script for the specified shell + + diff --git a/docs/reference/cli/evcc_completion_powershell.md b/docs/reference/cli/evcc_completion_powershell.md new file mode 100644 index 000000000..a3e539a68 --- /dev/null +++ b/docs/reference/cli/evcc_completion_powershell.md @@ -0,0 +1,43 @@ +# evcc completion powershell + +Generate the autocompletion script for powershell + +## Synopsis + +Generate the autocompletion script for powershell. + +To load completions in your current shell session: + +``` +evcc completion powershell | Out-String | Invoke-Expression +``` + +To load completions for every new session, add the output of the above command +to your powershell profile. + + +``` +evcc completion powershell [flags] +``` + +## Options + +``` + --no-descriptions disable completion descriptions +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc completion](evcc_completion.md) - Generate the autocompletion script for the specified shell + + diff --git a/docs/reference/cli/evcc_completion_zsh.md b/docs/reference/cli/evcc_completion_zsh.md new file mode 100644 index 000000000..468a15b89 --- /dev/null +++ b/docs/reference/cli/evcc_completion_zsh.md @@ -0,0 +1,63 @@ +# evcc completion zsh + +Generate the autocompletion script for zsh + +## Synopsis + +Generate the autocompletion script for the zsh shell. + +If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once: + +``` +echo "autoload -U compinit; compinit" >> ~/.zshrc +``` + +To load completions in your current shell session: + +``` +source <(evcc completion zsh) +``` + +To load completions for every new session, execute once: + +### Linux: + +``` +evcc completion zsh > "${fpath[1]}/_evcc" +``` + +### macOS: + +``` +evcc completion zsh > $(brew --prefix)/share/zsh/site-functions/_evcc +``` + +You will need to start a new shell for this setup to take effect. + + +``` +evcc completion zsh [flags] +``` + +## Options + +``` + --no-descriptions disable completion descriptions +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc completion](evcc_completion.md) - Generate the autocompletion script for the specified shell + + diff --git a/docs/reference/cli/evcc_configure.md b/docs/reference/cli/evcc_configure.md new file mode 100644 index 000000000..dd96a9963 --- /dev/null +++ b/docs/reference/cli/evcc_configure.md @@ -0,0 +1,32 @@ +# evcc configure + +Create configuration (evcc.yaml) + +``` +evcc configure [flags] +``` + +## Options + +``` + --advanced Enables handling of advanced configuration options + --category string Pre-select device category for advanced configuration (implies advanced) + --expand Enables rendering expanded configuration files + --lang string Define the localization to be used (en, de) +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_detect.md b/docs/reference/cli/evcc_detect.md new file mode 100644 index 000000000..8ddccd4e5 --- /dev/null +++ b/docs/reference/cli/evcc_detect.md @@ -0,0 +1,31 @@ +# evcc detect + +Auto-detect compatible hardware + +## Synopsis + +Automatic discovery using detect scans the local network for available devices. +Scanning focuses on devices that are commonly used that are detectable with reasonable efforts. + +On successful detection, suggestions for EVCC configuration can be made. The suggestions should simplify +configuring EVCC but are probably not sufficient for fully automatic configuration. + +``` +evcc detect [host ...] [subnet ...] [flags] +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_device.md b/docs/reference/cli/evcc_device.md new file mode 100644 index 000000000..ef9ca3679 --- /dev/null +++ b/docs/reference/cli/evcc_device.md @@ -0,0 +1,23 @@ +# evcc device + +Query database-configured devices (debug only) + +``` +evcc device [flags] +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_discuss.md b/docs/reference/cli/evcc_discuss.md new file mode 100644 index 000000000..81e16bcad --- /dev/null +++ b/docs/reference/cli/evcc_discuss.md @@ -0,0 +1,23 @@ +# evcc discuss + +Request support at Github Discussions (https://github.com/evcc-io/evcc/discussions/categories/erste-hilfe) + +``` +evcc discuss [flags] +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_dump.md b/docs/reference/cli/evcc_dump.md new file mode 100644 index 000000000..469164e8e --- /dev/null +++ b/docs/reference/cli/evcc_dump.md @@ -0,0 +1,29 @@ +# evcc dump + +Dump configuration + +``` +evcc dump [flags] +``` + +## Options + +``` + --cfg Dump config file +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_eebus-cert.md b/docs/reference/cli/evcc_eebus-cert.md new file mode 100644 index 000000000..61ddce565 --- /dev/null +++ b/docs/reference/cli/evcc_eebus-cert.md @@ -0,0 +1,23 @@ +# evcc eebus-cert + +Generate EEBUS certificate for using EEBUS compatible chargers + +``` +evcc eebus-cert [flags] +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_gendoc.md b/docs/reference/cli/evcc_gendoc.md new file mode 100644 index 000000000..cd447a1aa --- /dev/null +++ b/docs/reference/cli/evcc_gendoc.md @@ -0,0 +1,23 @@ +# evcc gendoc + +Generate CLI documentation in markdown format + +``` +evcc gendoc [flags] +``` + +# Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +# See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_health.md b/docs/reference/cli/evcc_health.md new file mode 100644 index 000000000..2f218f494 --- /dev/null +++ b/docs/reference/cli/evcc_health.md @@ -0,0 +1,23 @@ +# evcc health + +Check application health + +``` +evcc health [flags] +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_meter.md b/docs/reference/cli/evcc_meter.md new file mode 100644 index 000000000..d7a3c96f9 --- /dev/null +++ b/docs/reference/cli/evcc_meter.md @@ -0,0 +1,31 @@ +# evcc meter + +Query configured meters + +``` +evcc meter [name] [flags] +``` + +## Options + +``` + -b, --battery-mode string Set battery mode (normal, hold, charge) + -w, --battery-mode-wait duration Wait given duration during which potential watchdogs are active + -r, --repeat Repeat until interrupted +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_migrate.md b/docs/reference/cli/evcc_migrate.md new file mode 100644 index 000000000..d36f4d872 --- /dev/null +++ b/docs/reference/cli/evcc_migrate.md @@ -0,0 +1,29 @@ +# evcc migrate + +Migrate yaml to database (overwrites db settings) + +``` +evcc migrate [flags] +``` + +## Options + +``` + -r, --reset Reset migrated settings +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_password.md b/docs/reference/cli/evcc_password.md new file mode 100644 index 000000000..95820ebc9 --- /dev/null +++ b/docs/reference/cli/evcc_password.md @@ -0,0 +1,21 @@ +# evcc password + +Password administration + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging +* [evcc password reset](evcc_password_reset.md) - Reset password +* [evcc password set](evcc_password_set.md) - Set password + + diff --git a/docs/reference/cli/evcc_password_reset.md b/docs/reference/cli/evcc_password_reset.md new file mode 100644 index 000000000..1bec55a4b --- /dev/null +++ b/docs/reference/cli/evcc_password_reset.md @@ -0,0 +1,23 @@ +# evcc password reset + +Reset password + +``` +evcc password reset [flags] +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc password](evcc_password.md) - Password administration + + diff --git a/docs/reference/cli/evcc_password_set.md b/docs/reference/cli/evcc_password_set.md new file mode 100644 index 000000000..32a523db4 --- /dev/null +++ b/docs/reference/cli/evcc_password_set.md @@ -0,0 +1,23 @@ +# evcc password set + +Set password + +``` +evcc password set [flags] +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc password](evcc_password.md) - Password administration + + diff --git a/docs/reference/cli/evcc_settings.md b/docs/reference/cli/evcc_settings.md new file mode 100644 index 000000000..280a22080 --- /dev/null +++ b/docs/reference/cli/evcc_settings.md @@ -0,0 +1,21 @@ +# evcc settings + +Manage configuration settings + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging +* [evcc settings get](evcc_settings_get.md) - Get configuration settings +* [evcc settings set](evcc_settings_set.md) - Set configuration setting + + diff --git a/docs/reference/cli/evcc_settings_get.md b/docs/reference/cli/evcc_settings_get.md new file mode 100644 index 000000000..916ecc1ed --- /dev/null +++ b/docs/reference/cli/evcc_settings_get.md @@ -0,0 +1,23 @@ +# evcc settings get + +Get configuration settings + +``` +evcc settings get [flags] +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc settings](evcc_settings.md) - Manage configuration settings + + diff --git a/docs/reference/cli/evcc_settings_set.md b/docs/reference/cli/evcc_settings_set.md new file mode 100644 index 000000000..7630356b4 --- /dev/null +++ b/docs/reference/cli/evcc_settings_set.md @@ -0,0 +1,29 @@ +# evcc settings set + +Set configuration setting + +``` +evcc settings set [flags] +``` + +## Options + +``` + -f, --force Force (no confirmation) +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc settings](evcc_settings.md) - Manage configuration settings + + diff --git a/docs/reference/cli/evcc_sponsor.md b/docs/reference/cli/evcc_sponsor.md new file mode 100644 index 000000000..1a4e9d30f --- /dev/null +++ b/docs/reference/cli/evcc_sponsor.md @@ -0,0 +1,23 @@ +# evcc sponsor + +Validate sponsor token + +``` +evcc sponsor [name] [flags] +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_sunspec.md b/docs/reference/cli/evcc_sunspec.md new file mode 100644 index 000000000..a698b6ce4 --- /dev/null +++ b/docs/reference/cli/evcc_sunspec.md @@ -0,0 +1,29 @@ +# evcc sunspec + +Dump SunSpec model information + +``` +evcc sunspec [flags] +``` + +## Options + +``` + -i, --id int Slave id (default 1) +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_tariff.md b/docs/reference/cli/evcc_tariff.md new file mode 100644 index 000000000..b1a7c5fd7 --- /dev/null +++ b/docs/reference/cli/evcc_tariff.md @@ -0,0 +1,23 @@ +# evcc tariff + +Query configured tariff + +``` +evcc tariff [name] [flags] +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_token.md b/docs/reference/cli/evcc_token.md new file mode 100644 index 000000000..3b597585e --- /dev/null +++ b/docs/reference/cli/evcc_token.md @@ -0,0 +1,23 @@ +# evcc token + +Generate token credentials + +``` +evcc token [vehicle name] [flags] +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + + diff --git a/docs/reference/cli/evcc_vehicle.md b/docs/reference/cli/evcc_vehicle.md new file mode 100644 index 000000000..3da5ff7f2 --- /dev/null +++ b/docs/reference/cli/evcc_vehicle.md @@ -0,0 +1,34 @@ +# evcc vehicle + +Query configured vehicles + +``` +evcc vehicle [name] [flags] +``` + +## Options + +``` + --cloud Use cloud service (requires sponsor token) + -i, --current int Set maximum current + --diagnose Diagnose + -a, --start Start charging + -o, --stop Stop charging + -w, --wakeup Wake up +``` + +## Options inherited from parent commands + +``` + -c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml") + -h, --help Help + --ignore-db Run command ignoring service database + -l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info") + --log-headers Log headers +``` + +## See also + +* [evcc](evcc.md) - evcc - open source solar charging + +