better comments, adhere to cdn normalization

This commit is contained in:
John
2024-10-05 09:14:15 +02:00
parent 8c5c6c4cef
commit 254517f9db
2 changed files with 16 additions and 16 deletions
+1 -1
View File
@@ -18,7 +18,7 @@
* add option to discover device via mDNS * add option to discover device via mDNS
* add dedicated log level for device messages * add dedicated log level for device messages
* add option to extend MQTT variables from env/cmdline * add option to extend MQTT variables from env/cmdline
* add date+datetime to Home Assistant MQTT discovery integration * add date+datetime mapping and better device update check to Home Assistant MQTT discovery integration
## Breaking Changes ## Breaking Changes
* change default config path to https://ebus.github.io/ serving files generated from new TypeSpec message definition sources * change default config path to https://ebus.github.io/ serving files generated from new TypeSpec message definition sources
+15 -15
View File
@@ -155,11 +155,11 @@ type_map-datetime = datetime
type_map-string = type_map-string =
# field type switch designator, see below. # field type switch designator, see below.
# HA integration: this is used to set several variable values depending on the field type, message name, field name, and unit. # HA integration: this is used to set several variable values depending on the field type, message name+field name, and unit.
type_switch-by = %name%field,%unit type_switch-by = %name%field,%unit
# field type switch variables names to use in addition to %type_switch in case of multiple keys (separated by comma). # field type switch variables names to use in addition to %type_switch in case of multiple keys (separated by comma).
# HA integration: var names for topic/class/state/sub values mapped from field type, message name, field name, and unit. # HA integration: var names for topic/class/state/sub values mapped from field type, message name+field name, and unit.
type_switch-names = type_topic,type_class,type_state,type_sub type_switch-names = type_topic,type_class,type_state,type_sub
# field type switch for each field type and optionally direction (between dash before the field type) available as # field type switch for each field type and optionally direction (between dash before the field type) available as
@@ -169,7 +169,7 @@ type_switch-names = type_topic,type_class,type_state,type_sub
# when the wildcard string in the right part matched the "type_switch-by" value. The list is traversed from top to # when the wildcard string in the right part matched the "type_switch-by" value. The list is traversed from top to
# bottom stopping at the first match. If direction specific definitions exist, these are traversed first. If no line # bottom stopping at the first match. If direction specific definitions exist, these are traversed first. If no line
# matches at all, the variable(s) are set to the empty string. # matches at all, the variable(s) are set to the empty string.
# HA integration: the mapping list for (potentially) writable number entities by field type, name, message, and unit. # HA integration: the mapping list for (potentially) writable number entities field type, message name+field name, and unit.
type_switch-w-number = type_switch-w-number =
number,temperature, = temp|,°C$ number,temperature, = temp|,°C$
number,temperature, = temp|,K$ number,temperature, = temp|,K$
@@ -177,21 +177,21 @@ type_switch-w-number =
number,power_factor, = power*%% number,power_factor, = power*%%
number,power, = power|,kW$|,W$ number,power, = power|,kW$|,W$
number,voltage, = volt|,V$ number,voltage, = volt|,V$
number,current, = current,|,A$ number,current, = current,|currentvalue,|,A$
number,pressure, = bar$ number,pressure, = bar$
number,gas, = gas*/min$ number,gas, = gas*/min$
number,humidity, = humid*%%$ number,humidity, = humid*%%$
number,, = curve, number,, = curve,|curvevalue,
# HA integration: the mapping list for numeric sensor entities by field type, name, message, and unit. # HA integration: the mapping list for numeric sensor entities field type, message name+field name, and unit.
type_switch-number = type_switch-number =
sensor,,total_increasing = poweron|count, sensor,,total_increasing = poweron|count,|countvalue,
sensor,temperature,measurement = temp|,°C$ sensor,temperature,measurement = temp|,°C$
sensor,temperature,measurement = temp|,K$ sensor,temperature,measurement = temp|,K$
sensor,power_factor,measurement = power*%% sensor,power_factor,measurement = power*%%
sensor,power,measurement = power|,kW$|,W$ sensor,power,measurement = power|,kW$|,W$
sensor,voltage,measurement = volt|,V$ sensor,voltage,measurement = volt|,V$
sensor,current,measurement = current,|,A$ sensor,current,measurement = current,|currentvalue,|,A$
sensor,,measurement = integral|,°min$ sensor,,measurement = integral|,°min$
sensor,energy,total_increasing = energy|,Wh$ sensor,energy,total_increasing = energy|,Wh$
sensor,yield,total_increasing = total*,Wh$ sensor,yield,total_increasing = total*,Wh$
@@ -202,35 +202,35 @@ type_switch-number =
sensor,humidity,measurement = humid*%%$ sensor,humidity,measurement = humid*%%$
sensor,, = sensor,, =
# HA integration: the mapping list for (potentially) writable binary switch entities by field type, name, message, and unit. # HA integration: the mapping list for (potentially) writable binary switch entities field type, message name+field name, and unit.
type_switch-w-list = type_switch-w-list =
switch,, = onoff switch,, = onoff
switch,,,yesno = yesno switch,,,yesno = yesno
select,, = select,, =
# HA integration: the mapping list for rather binary sensor entities by field type, name, message, and unit. # HA integration: the mapping list for rather binary sensor entities field type, message name+field name, and unit.
type_switch-list = type_switch-list =
binary_sensor,,measurement = onoff binary_sensor,,measurement = onoff
binary_sensor,,measurement,yesno = yesno binary_sensor,,measurement,yesno = yesno
sensor,,,list = sensor,,,list =
# HA integration: the mapping list for (potentially) writable string entities containing a time value by field type, name, message, and unit. # HA integration: the mapping list for (potentially) writable string entities containing a time value field type, message name+field name, and unit.
type_switch-w-time = type_switch-w-time =
text,,,time = from,|to,|time2,|timer text,,,time = from,|to,|time2,|timer
text,,,time3 = time, text,,,time3 = time,|timevalue,
type_switch-time = type_switch-time =
sensor,,,time = from,|to,|time2,|timer sensor,,,time = from,|to,|time2,|timer
sensor,,,time3 = time, sensor,,,time3 = time,|timevalue,
# HA integration: the mapping list for (potentially) writable string entities containing a date value by field type, name, message, and unit. # HA integration: the mapping list for (potentially) writable string entities containing a date value field type, message name+field name, and unit.
type_switch-w-date = type_switch-w-date =
text,,,date = text,,,date =
type_switch-date = type_switch-date =
sensor,,, = sensor,,, =
# HA integration: the mapping list for (potentially) writable string entities containing a datetime value by field type, name, message, and unit. # HA integration: the mapping list for (potentially) writable string entities containing a datetime value field type, message name+field name, and unit.
type_switch-w-datetime = type_switch-w-datetime =
text,,,datetime = text,,,datetime =