Skip to content

Generate device docs from release #534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
38 changes: 0 additions & 38 deletions docs/devices/chargers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -464,25 +464,6 @@ chargers:

<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger -->

## CUBOS C11E, C22E

<DeviceFeatures features="rfid" />

Der 'Modbus TCP Server für Energiemanagement-Systeme' muss aktiviert sein. 'Registersatz' darf NICHT auf 'Phoenix' oder 'TQ-DM100' eingestellt sein. Die dritte Auswahlmöglichkeit 'Ebee', 'Bender', 'MENNEKES' etc. ist richtig. 'UID Übertragung erlauben' muss aktiviert sein.

```yaml
chargers:
- name: my_charger
type: template
template: bender
host: 192.0.2.2 # IP-Adresse oder Hostname
port: 502 # Port (optional)
```

<SponsorshipRequired />

<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger -->

## Cupra

### Charger Connect (Beta)
Expand Down Expand Up @@ -2152,25 +2133,6 @@ chargers:

<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger -->

## Spelsberg Wallbox

<DeviceFeatures features="rfid" />

Der 'Modbus TCP Server für Energiemanagement-Systeme' muss aktiviert sein. 'Registersatz' darf NICHT auf 'Phoenix' oder 'TQ-DM100' eingestellt sein. Die dritte Auswahlmöglichkeit 'Ebee', 'Bender', 'MENNEKES' etc. ist richtig. 'UID Übertragung erlauben' muss aktiviert sein.

```yaml
chargers:
- name: my_charger
type: template
template: bender
host: 192.0.2.2 # IP-Adresse oder Hostname
port: 502 # Port (optional)
```

<SponsorshipRequired />

<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger -->

## Stark in Strom Easy

<DeviceFeatures features="sponsorfree" />
Expand Down
2 changes: 1 addition & 1 deletion docs/devices/meters.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5059,7 +5059,7 @@ meters:

<DeviceFeatures features="" />

Nur ein System kann und darf zeitgleich eine Modbus TCP-Verbindung zum Wechselrichter haben!
Nur ein System kann und darf auf den Wechselrichter zugreifen!
Für die optionale Batteriesteuerung muss StorageConf_CtrlMode (0xE004) auf 4 "Remote" stehen.

<Tabs>
Expand Down
3 changes: 2 additions & 1 deletion docs/devices/vehicles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,8 @@ vehicles:
accessToken: # Siehe https://docs.evcc.io/docs/devices/vehicles#tesla
refreshToken: # Siehe https://docs.evcc.io/docs/devices/vehicles#tesla
vin: W... # Erforderlich, wenn mehrere Fahrzeuge des Herstellers vorhanden sind (optional)
capacity: 50 # Akkukapazität in kWh (optional)
capacity: 50 # Akkukapazität in kWh (optional)
control: # Notwendig für Tesla Wall Connector. Der Virtual Key für evcc muss eingerichtet sein. Siehe https://tesla.evcc.io (optional)
```

<SponsorshipRequired />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -465,25 +465,6 @@ chargers:

<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger -->

## CUBOS C11E, C22E

<DeviceFeatures features="rfid" />

The 'Modbus TCP Server' must be enabled. The setting 'Register Address Set' must NOT be set to 'Phoenix' or 'TQ-DM100'. Use the third selection labeled 'Ebee', 'Bender', 'MENNEKES' etc. Set 'Allow UID Disclose' to On.

```yaml
chargers:
- name: my_charger
type: template
template: bender
host: 192.0.2.2 # IP address or hostname
port: 502 # Port (optional)
```

<SponsorshipRequired />

<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger -->

## Cupra

### Charger Connect (Beta)
Expand Down Expand Up @@ -2153,25 +2134,6 @@ chargers:

<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger -->

## Spelsberg Wallbox

<DeviceFeatures features="rfid" />

The 'Modbus TCP Server' must be enabled. The setting 'Register Address Set' must NOT be set to 'Phoenix' or 'TQ-DM100'. Use the third selection labeled 'Ebee', 'Bender', 'MENNEKES' etc. Set 'Allow UID Disclose' to On.

```yaml
chargers:
- name: my_charger
type: template
template: bender
host: 192.0.2.2 # IP address or hostname
port: 502 # Port (optional)
```

<SponsorshipRequired />

<!-- AUTO-GENERATED FROM TEMPLATE - PLEASE EDIT HERE https://github.com/evcc-io/evcc/tree/master/templates/definition/charger -->

## Stark in Strom Easy

<DeviceFeatures features="sponsorfree" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5060,8 +5060,8 @@ meters:

<DeviceFeatures features="" />

Only one system can and may have a Modbus TCP connection to the inverter at the same time!
For optional battery control, StorageConf_CtrlMode (0xE004) must be set to 4 "Remote".
Only one system may access the inverter!
For optional battery control, StorageConf_CtrlMode (0xE004) must be at 4 "Remote".

<Tabs>
<TabItem value="grid" label="Netz" default>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,8 @@ vehicles:
accessToken: # See https://docs.evcc.io/en/docs/devices/vehicles#tesla
refreshToken: # See https://docs.evcc.io/en/docs/devices/vehicles#tesla
vin: W... # Required if you own multiple vehicles of the same brand (optional)
capacity: 50 # Battery capacity in kWh (optional)
capacity: 50 # Battery capacity in kWh (optional)
control: # Use with Tesla Wall Connector. The Virtual Key for evcc must be installed. See https://tesla.evcc.io (optional)
```

<SponsorshipRequired />
Expand Down
4 changes: 2 additions & 2 deletions src/generateFromTemplate.js
Original file line number Diff line number Diff line change
Expand Up @@ -184,11 +184,11 @@ function generateMarkdown(data, type, target) {

["vehicle", "meter", "charger"].forEach((type) => {
// German
const templatesDe = readTemplates(`./templates/de/${type}`);
const templatesDe = readTemplates(`./templates/release/de/${type}`);
generateMarkdown(templatesDe, type, `./docs/devices/${type}s.mdx`);

// English
const templatesEn = readTemplates(`./templates/en/${type}`);
const templatesEn = readTemplates(`./templates/release/en/${type}`);
generateMarkdown(
templatesEn,
type,
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading