docu: added explanation for parameters in pyPlc.ini.template

This commit is contained in:
uhi22 2023-06-28 08:01:25 +02:00
parent 2b5806bf43
commit 5f1d281c7a

View file

@ -2,13 +2,21 @@
# Copy this file in the same folder like the pyPlc.py, and rename it to pyPlc.ini # Copy this file in the same folder like the pyPlc.py, and rename it to pyPlc.ini
[general] [general]
# mode can be either PevMode to use as car, or EvseMode to use as charger # mode can be either PevMode to use as car, or EvseMode to use as charger.
# This setting can be overruled by using the first command line parameter, to EvseMode:
# python pyPlc.py E
# or to PevMode:
# python pyPlc.py P
mode = PevMode mode = PevMode
# Simulation without modem # Simulation without modem
# For development purposes, make it possible to run two instances (pev and evse) on one machine, without # For development purposes, make it possible to run two instances (pev and evse) on one machine, without
# a modem connected. This feature is not tested since a long time, most likely does not work as intended. # a modem connected. This feature is not tested since a long time, most likely does not work as intended.
# todo: replace isSimulationMode by this setting # If this setting is set to false, nevertheless the simulation mode can be activated by the second command
# line parameter "S", e.g.
# python pyPlc.py E S
# or
# python pyPlc.py P S
is_simulation_without_modems = false is_simulation_without_modems = false
# The Ethernet interface. Usually eth0 on Raspberry. # The Ethernet interface. Usually eth0 on Raspberry.
@ -20,14 +28,17 @@ eth_interface = eth0
eth_windows_interface_name = \Device\NPF_{E4B8176C-8516-4D48-88BC-85225ABCF259} eth_windows_interface_name = \Device\NPF_{E4B8176C-8516-4D48-88BC-85225ABCF259}
# If a display is connected via serial line, e.g. an WIFI-KIT-32 running the software from https://github.com/uhi22/SerialToOLED # If a display is connected via serial line, e.g. an WIFI-KIT-32 running the software from https://github.com/uhi22/SerialToOLED
# Possible values: yes or no
display_via_serial = yes display_via_serial = yes
# LightBulbDemo turns on the relay with a short delay in the charging loop, to stabilize the voltage # LightBulbDemo turns on the relay with a short delay in the charging loop, to stabilize the voltage
# before the resistive load is connected. # before the resistive load is connected.
# Possible values: yes or no
light_bulb_demo = no light_bulb_demo = no
# SOC simulation. # SOC simulation.
# In PevMode, simulate a rising SOC while charging. # In PevMode, simulate a rising SOC while charging.
# Possible values: yes or no
soc_simulation = yes soc_simulation = yes
# Device selection for the digital outputs, for CP state and power relays # Device selection for the digital outputs, for CP state and power relays
@ -101,9 +112,17 @@ udp_syslog_enable = Yes
# Set backend for obtaining charging parameters, we start with CHAdeMO CAN for now # Set backend for obtaining charging parameters, we start with CHAdeMO CAN for now
# Need to make a simulator device and maybe a celeron device? # Need to make a simulator device and maybe a celeron device?
# Possible values:
# chademo: pyPLC is used as bridge between a CCS charger and a CHAdeMO* car.
# Limitations/explanations here: https://openinverter.org/forum/viewtopic.php?p=57894#p57894 and
# https://openinverter.org/forum/viewtopic.php?t=1063 (Is it possible to make a CCS to CHAdeMO adapter?)
# none: all other use cases
charge_parameter_backend = chademo charge_parameter_backend = chademo
# REST callback for SoC states. Comment out to disable. Do not leave a trailing slash # REST callback for SoC states. Comment out to disable. Do not leave a trailing slash
# This parameter is used in EvseMode, to configure where the data which is retrieved
# from the vehicle shall go to. Discussed
# here: https://github.com/SmartEVSE/SmartEVSE-3/issues/25#issuecomment-1563519025
soc_callback_enabled = False soc_callback_enabled = False
soc_callback_endpoint = http://1.1.1.1 soc_callback_endpoint = http://1.1.1.1
# Fallback value to use if the vehicle does not support the EVEnergyCapacity.Value # Fallback value to use if the vehicle does not support the EVEnergyCapacity.Value