From a328c16ab1f0ddc417029fda9de67e276224db9b Mon Sep 17 00:00:00 2001 From: Verschwiegener Date: Fri, 18 Oct 2024 03:33:39 +0200 Subject: [PATCH 1/4] Battery Definition #171 Clearer Battery Description Battery Power Modes of Operation Moved Battery Definition to WiringObject Add UN Number --- gdtf-spec.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/gdtf-spec.md b/gdtf-spec.md index 07ae9da4..2c52f347 100644 --- a/gdtf-spec.md +++ b/gdtf-spec.md @@ -214,6 +214,7 @@ specified in [Table 1](#user-content-table-1 ). |Int | Integer | Signed integer| |Hex | Integer | Number in hexadecimal notation; Default value: 0| |Float | float | Floating point numeric; Separator: "."| +|Bool | Bool | A boolean value. When representing true inidcate with true, when false indicate with false.| |String | Literal | Text| |Name | restricted Literal | Unique object names; The allowed characters are listed in [AnnexC](#user-content-table-c1) Default value: object type with an index in parent.| |Date | yyyy-mm-ddThh:mm:ss | Date and time corresponding to UTC +00:00 (Coordinated Universal Time): yyyy – year, mm – month, dd – day, hh – hours (24 format), mm – minutes, ss – seconds. Example: “2016-06-21T11:22:48” | @@ -1738,7 +1739,7 @@ defined XML attributes of a wiring object geometry are specified in [table 50](# | Model | [Name](#user-content-attrtype-name ) | Link to the corresponding model. | | ConnectorType | [Name](#user-content-attrtype-name ) | The type of the connector. Find a list of predefined types in [Annex D](#user-content-table-d1 ). This is not applicable for Component Types Fuses. Custom type of connector can also be defined, for example "Loose End".| | Position | [Matrix](#user-content-attrtype-matrix ) | Relative position of geometry; Default value: Identity Matrix | -| ComponentType | [Enum](#user-content-attrtype-enum ) | The type of the electrical component used. Defined values are "Input", "Output", "PowerSource", "Consumer", "Fuse", "NetworkProvider", "NetworkInput", "NetworkOutput", "NetworkInOut". | +| ComponentType | [Enum](#user-content-attrtype-enum ) | The type of the electrical component used. Defined values are "Input", "Output", "PowerSource", "Consumer", "Fuse", "NetworkProvider", "NetworkInput", "NetworkOutput", "NetworkInOut", "Battery". | | SignalType | [String](#user-content-attrtype-string ) | The type of the signal used. Predefinded values are "Power", "DMX512", "Protocol", "AES", "AnalogVideo", "AnalogAudio". When you have a custom protocol, you can add it here. | | PinCount | [Int](#user-content-attrtype-int ) | The number of available pins of the connector type to connect internal wiring to it. | | ElectricalPayLoad | [Float](#user-content-attrtype-float ) | The electrical consumption in Watts. Only for [Consumers](#user-content-attrtype-connectortype ). Unit: Watt. | @@ -1754,6 +1755,11 @@ defined XML attributes of a wiring object geometry are specified in [table 50](# | FuseRating | [Enum](#user-content-attrtype-enum ) | Fuse Rating. Defined values are "B", "C", "D", "K", "Z". | | Orientation | [Enum](#user-content-attrtype-enum ) | Where the pins are placed on the object. Defined values are "Left", "Right", "Top", "Bottom". | | WireGroup | [String](#user-content-attrtype-string ) | Name of the group to which this wiring object belong. | +| BatteryType | [Enum](#ser-content-attrtype-enum ) | The Type of the Battery Unit. Defined values are "Soldered", "Replacable", "Quickswap", "External". | +| BatteryOperation | [Enum](#user-content-attrtype-enum ) | The function of the Fixture under Battery Power. Defined values are "Configuration", "Operation". | +| BatteryRuntime | [Float](#user-content-attrtype-float ) | The Runtime of the Fixture under Battery Power. Only for [Operation](#attrtype-batteryoperation ). +| ChargingTime | [Float](#user-content-attrtype-float ) | The Time it takes to charge the Fixture from 0 to 100%. | +| UN | [Integer](#user-content-attrtype-integer ) | Defines the Battery UN number for fixture transport | From 8debfb3ed11648fd9da156af9265b1c7a47d4eb9 Mon Sep 17 00:00:00 2001 From: petrvanekrobe <45997318+petrvanekrobe@users.noreply.github.com> Date: Thu, 11 Jun 2026 10:15:33 +0200 Subject: [PATCH 2/4] Battery specification - add more fields - Battery proposal: remove bool - Generally, we try to avoid bool as often, over time more states then 0/1 are needed. - Added new battery-related attributes to the specification. --- gdtf-spec.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/gdtf-spec.md b/gdtf-spec.md index 2c52f347..5f8f1c5f 100644 --- a/gdtf-spec.md +++ b/gdtf-spec.md @@ -214,7 +214,6 @@ specified in [Table 1](#user-content-table-1 ). |Int | Integer | Signed integer| |Hex | Integer | Number in hexadecimal notation; Default value: 0| |Float | float | Floating point numeric; Separator: "."| -|Bool | Bool | A boolean value. When representing true inidcate with true, when false indicate with false.| |String | Literal | Text| |Name | restricted Literal | Unique object names; The allowed characters are listed in [AnnexC](#user-content-table-c1) Default value: object type with an index in parent.| |Date | yyyy-mm-ddThh:mm:ss | Date and time corresponding to UTC +00:00 (Coordinated Universal Time): yyyy – year, mm – month, dd – day, hh – hours (24 format), mm – minutes, ss – seconds. Example: “2016-06-21T11:22:48” | @@ -1755,12 +1754,14 @@ defined XML attributes of a wiring object geometry are specified in [table 50](# | FuseRating | [Enum](#user-content-attrtype-enum ) | Fuse Rating. Defined values are "B", "C", "D", "K", "Z". | | Orientation | [Enum](#user-content-attrtype-enum ) | Where the pins are placed on the object. Defined values are "Left", "Right", "Top", "Bottom". | | WireGroup | [String](#user-content-attrtype-string ) | Name of the group to which this wiring object belong. | -| BatteryType | [Enum](#ser-content-attrtype-enum ) | The Type of the Battery Unit. Defined values are "Soldered", "Replacable", "Quickswap", "External". | -| BatteryOperation | [Enum](#user-content-attrtype-enum ) | The function of the Fixture under Battery Power. Defined values are "Configuration", "Operation". | -| BatteryRuntime | [Float](#user-content-attrtype-float ) | The Runtime of the Fixture under Battery Power. Only for [Operation](#attrtype-batteryoperation ). -| ChargingTime | [Float](#user-content-attrtype-float ) | The Time it takes to charge the Fixture from 0 to 100%. | -| UN | [Integer](#user-content-attrtype-integer ) | Defines the Battery UN number for fixture transport | - +| BatteryInstallationType | [Enum](#user-content-attrtype-enum ) | The Installation Type of the Battery. Defined values are "Internal", "External", "Removable", "Replaceable", "HotSwappable", "Integrated", "Other". Default value: "TBD"| +| BatteryOperationMode | [Enum](#user-content-attrtype-enum ) | The function of the Device under Battery Power. Defined values are "Configuration", "Operation". Default value: "TBD"| +| BatteryEnergyCapacity | [Float](#user-content-attrtype-float ) | The Energy Capacity of the Battery in watt-hours (Wh) Default value: "TBD" | +| BatteryMaxPower | [Float](#user-content-attrtype-float) | The maximum output power of the Battery, in watts (W). Default value: "TBD"| +| BatteryChargingTime | [Float](#user-content-attrtype-float ) | The Time in seconds it takes to charge the Battery from 0 to 100%. Default value: "TBD"| +| BatteryUNTransportCode | [Array of Int](#user-content-attrtype-int ) | Defines the Battery UN numbers for transport. Default value: "TBD"| +| BatteryTechnology | [Enum](#user-content-attrtype-enum ) | The Technology Chemistry of the Battery. Defined values are "Li-ion", "LiPo", "LiFePO4", "LTO", "Lead-acid", "AGM", "Gel", "NiMH","NiCd","Sodium-ion", "Alkaline","Lithium-primary","Other". Default value: "Other" Default value: "TBD"| +| BatteryRechargeable | [Enum](#user-content-attrtype-enum ) | If the Battery can be charged. Defined values are "Yes", "No". Default value: "TBD"| From 550910bb3b4890c8497f49c9ec226c159734486c Mon Sep 17 00:00:00 2001 From: Petr Vanek Date: Fri, 19 Jun 2026 14:58:00 +0200 Subject: [PATCH 3/4] Separate the Battery into own geometry type --- gdtf-spec.md | 56 ++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 46 insertions(+), 10 deletions(-) diff --git a/gdtf-spec.md b/gdtf-spec.md index 5f8f1c5f..d0fb5504 100644 --- a/gdtf-spec.md +++ b/gdtf-spec.md @@ -1738,7 +1738,7 @@ defined XML attributes of a wiring object geometry are specified in [table 50](# | Model | [Name](#user-content-attrtype-name ) | Link to the corresponding model. | | ConnectorType | [Name](#user-content-attrtype-name ) | The type of the connector. Find a list of predefined types in [Annex D](#user-content-table-d1 ). This is not applicable for Component Types Fuses. Custom type of connector can also be defined, for example "Loose End".| | Position | [Matrix](#user-content-attrtype-matrix ) | Relative position of geometry; Default value: Identity Matrix | -| ComponentType | [Enum](#user-content-attrtype-enum ) | The type of the electrical component used. Defined values are "Input", "Output", "PowerSource", "Consumer", "Fuse", "NetworkProvider", "NetworkInput", "NetworkOutput", "NetworkInOut", "Battery". | +| ComponentType | [Enum](#user-content-attrtype-enum ) | The type of the electrical component used. Defined values are "Input", "Output", "PowerSource", "Consumer", "Fuse", "NetworkProvider", "NetworkInput", "NetworkOutput", "NetworkInOut". | | SignalType | [String](#user-content-attrtype-string ) | The type of the signal used. Predefinded values are "Power", "DMX512", "Protocol", "AES", "AnalogVideo", "AnalogAudio". When you have a custom protocol, you can add it here. | | PinCount | [Int](#user-content-attrtype-int ) | The number of available pins of the connector type to connect internal wiring to it. | | ElectricalPayLoad | [Float](#user-content-attrtype-float ) | The electrical consumption in Watts. Only for [Consumers](#user-content-attrtype-connectortype ). Unit: Watt. | @@ -1754,15 +1754,6 @@ defined XML attributes of a wiring object geometry are specified in [table 50](# | FuseRating | [Enum](#user-content-attrtype-enum ) | Fuse Rating. Defined values are "B", "C", "D", "K", "Z". | | Orientation | [Enum](#user-content-attrtype-enum ) | Where the pins are placed on the object. Defined values are "Left", "Right", "Top", "Bottom". | | WireGroup | [String](#user-content-attrtype-string ) | Name of the group to which this wiring object belong. | -| BatteryInstallationType | [Enum](#user-content-attrtype-enum ) | The Installation Type of the Battery. Defined values are "Internal", "External", "Removable", "Replaceable", "HotSwappable", "Integrated", "Other". Default value: "TBD"| -| BatteryOperationMode | [Enum](#user-content-attrtype-enum ) | The function of the Device under Battery Power. Defined values are "Configuration", "Operation". Default value: "TBD"| -| BatteryEnergyCapacity | [Float](#user-content-attrtype-float ) | The Energy Capacity of the Battery in watt-hours (Wh) Default value: "TBD" | -| BatteryMaxPower | [Float](#user-content-attrtype-float) | The maximum output power of the Battery, in watts (W). Default value: "TBD"| -| BatteryChargingTime | [Float](#user-content-attrtype-float ) | The Time in seconds it takes to charge the Battery from 0 to 100%. Default value: "TBD"| -| BatteryUNTransportCode | [Array of Int](#user-content-attrtype-int ) | Defines the Battery UN numbers for transport. Default value: "TBD"| -| BatteryTechnology | [Enum](#user-content-attrtype-enum ) | The Technology Chemistry of the Battery. Defined values are "Li-ion", "LiPo", "LiFePO4", "LTO", "Lead-acid", "AGM", "Gel", "NiMH","NiCd","Sodium-ion", "Alkaline","Lithium-primary","Other". Default value: "Other" Default value: "TBD"| -| BatteryRechargeable | [Enum](#user-content-attrtype-enum ) | If the Battery can be charged. Defined values are "Yes", "No". Default value: "TBD"| - The wiring object has the same children types as the geometry @@ -1790,6 +1781,51 @@ defined XML attributes of a pin patch are specified in [table 51](#user-content- The pin patch doesn't have any children. +### Geometry Type Battery + +This type of geometry is used to describe a geometry used for the battery (XML node ``). The currently +defined XML attributes of a battery geometry are specified in +[table xx](#user-content-table-xx ). + +
+ +#### Table xx. *Battery Attributes* + +| XML Attribute Name | Value Type | Description | +|----|----|----| +| Name | [Name](#user-content-attrtype-name ) | The unique name of the geometry. | +| Model | [Name](#user-content-attrtype-name ) | Link to the corresponding model. | +| Position | [Matrix](#user-content-attrtype-matrix ) | Relative position of geometry; Default value: Identity Matrix | +| InstallationType| [Enum](#user-content-attrtype-enum ) | The Installation Type of the Battery. Defined values are "Internal", "Removable", "Replaceable", "HotSwappable", "Integrated", "Other". Default value: "Internal"| +| OperationMode | [Enum](#user-content-attrtype-enum ) | The function of the Device under Battery Power. Defined values are "Configuration", "Operation". Default value: "Operation"| +| Voltage | [Float](#user-content-attrtype-float ) | The voltage output of the battery. Unit: volt. Default value: "0" | +| EnergyCapacity | [Float](#user-content-attrtype-float ) | The Energy Capacity of the Battery in watt-hours (Wh) Default value: "0" | +| MaxPower | [Float](#user-content-attrtype-float) | The maximum output power of the Battery, in watts (W). Default value: "0"| +| UNTransportCode | [Array of String](#user-content-attrtype-string) | Defines the Battery UN numbers for transport. Default value: empty array| +| Technology | [Enum](#user-content-attrtype-enum ) | The Technology Chemistry of the Battery. Defined values are "Li-ion", "LiPo", "LiFePO4", "LTO", "Lead-acid", "AGM", "Gel", "NiMH","NiCd","Sodium-ion", "Alkaline","Lithium-primary","Other". Default value: "Other" Default value: "Li-ion"| +| Rechargeable | [Enum](#user-content-attrtype-enum ) | If the Battery can be charged. Defined values are "Yes", "No". Default value: "Yes"| +
+ +The battery has the same children types as the geometry collect (see [table +34](#user-content-table-34 )). In addition, it also has a list of charging +times (XML node ``) as children. + +#### Charging Time + +This XML node (XML node ``) specifies the time it takes for the +battery to be charged to a given capacity percentage. The currently defined XML +attributes of the charging time are specified in [table +xx](#user-content-table-xx). + +
+ +#### Table xx. *Charging Time Attributes* + +| XML Attribute Name | Value Type | Description | +|----|----|----| +| CapacityPercentage | [Int](#user-content-attrtype-int ) | Percentage of battery capacity between 1 and 100 for which the charging time is provided. Default value: "0"| +| Time | [Int](#user-content-attrtype-int ) | The Time in seconds it takes to charge the defined percentage. Default value: "0"| + ### Geometry Type Inventory This type of geometry is used to describe a geometry used for the inventory (XML node ``). The currently From e60fc0b1b3c75e74f2e71309810adfa88618de5e Mon Sep 17 00:00:00 2001 From: Petr Vanek Date: Wed, 24 Jun 2026 07:52:09 +0200 Subject: [PATCH 4/4] Add battery example --- gdtf-spec.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/gdtf-spec.md b/gdtf-spec.md index d0fb5504..66fa2523 100644 --- a/gdtf-spec.md +++ b/gdtf-spec.md @@ -1826,6 +1826,25 @@ xx](#user-content-table-xx). | CapacityPercentage | [Int](#user-content-attrtype-int ) | Percentage of battery capacity between 1 and 100 for which the charging time is provided. Default value: "0"| | Time | [Int](#user-content-attrtype-int ) | The Time in seconds it takes to charge the defined percentage. Default value: "0"| +Example of Battery: + +```xml + + + + +``` + ### Geometry Type Inventory This type of geometry is used to describe a geometry used for the inventory (XML node ``). The currently