Skip to content

Battery specification proposal #311

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.

Sign up for GitHub

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

Open
petrvanekrobe wants to merge 4 commits into
base: next
Choose a base branch
from
Open

Battery specification proposal #311

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a328c16
Battery Definition #171
Verschwiegener Oct 18, 2024
8debfb3
Battery specification - add more fields
petrvanekrobe Jun 11, 2026
550910b
Separate the Battery into own geometry type
petrvanekrobe Jun 19, 2026
e60fc0b
Add battery example
petrvanekrobe Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 64 additions & 2 deletions gdtf-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1754,8 +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. |


</div>

The wiring object has the same children types as the geometry
Expand Down Expand Up @@ -1783,6 +1781,70 @@ 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 `<Battery>`). The currently
defined XML attributes of a battery geometry are specified in
[table xx](#user-content-table-xx ).

<div id="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 <a id="attrtype-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"|
</div>

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 `<ChargingTime>`) as children.

#### Charging Time

This XML node (XML node `<ChargingTime>`) 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).

<div id="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"|

Example of Battery:

```xml
<Battery Name="MainBattery"
Model="MainBattery"
Position="{1.000000,0.000000,0.000000,0.000000}{0.000000,1.000000,0.000000,0.000000}{0.000000,0.000000,1.000000,0.000000}
{0.000000,0.000000,0.000000,1.000000}"
InstallationType="Removable"
OperationMode="Operation"
Voltage="14.8"
EnergyCapacity="118.4"
MaxPower="180"
Technology="Li-ion"
Rechargeable="Yes">
<ChargingTime CapacityPercentage="80" Time="2700" />
<ChargingTime CapacityPercentage="100" Time="5400" />
</Battery>
```

### Geometry Type Inventory

This type of geometry is used to describe a geometry used for the inventory (XML node `<Inventory>`). The currently
Expand Down
Loading