search

iot-schema-collab / iotschema

30 stars 12 forks source link

Capability: ElectricBattery #67

Open danicic opened 5 years ago

danicic commented 5 years ago

Capability ElectricBattery

An electric battery (an electric power storage system) is an electric power system that is capable of storing electricity. Usually a battery, an electric vehicle, or a microgrid.

Properties

Name Description Input Output
StateOfCharge The rounded percentage of the current charging level of a battery in the range of [0, 100] - StateOfChargeData
Capacity The total capacity of battery. - ElectricChargeData
Charging The status of charging. 'True' indicates enabled, and ''False' indicates not enabled. - ChargingStatusData
Discharging The status of discharging. 'True' indicates charging, and 'False' indicates not charging. - ChargingStatusData
LowBattery Indication that the battery is in a low state of charge. - LowBatteryData
MaxChargeCurrent It is the charge electric current limit (CCL) - ElectricCurrentData
MaxDischargeCurrent It is the discharge electric current limit (DCL) - ElectricCurrentData
MaxChargePower It is the charging power limit. - PowerData
MaxDischargePower It is the discharging power limit. - PowerData

Provide Input for writable properties.

Actions

Name Description Input Output
ChargeBattery Charge a battery (an electric power storage system) with either C-rate or E-rate. CRateData or ERateData -
DischargeBattery Discharge a battery (an electric power storage system) either with C-rate or E-rate. CRateData or ERateData -
SetPointBattery Charge or discharge a battery (an electric power storage system) either with C-rate or E-rate. When charging it's a positive number and when discharging it's a negative number. CRateData or ERateData -

Events

Name Description Input Output
BatteryLowVoltageAlarm Battery low voltage alarm warns of impending battery failure. - VoltageData
OverTemperatureAlarm Too high temperature. - TemperatureData
UnderTemperatureAlarm Too low temperature. - TemperatureData
OverElectricCurrentAlarm Too high electric current (e.g., a battery is charged or discharged with). - ElectricCurrentData
OverVoltageAlarm Too high voltage (e.g., a battery is charged or discharged with). - VoltageData
UnderVoltageAlarm Too low voltage (e.g., a battery is charged or discharged with). - VoltageData
OverPressureAlarm Too high pressure. - PressureData

Data Types

Numeric Data Types:

Name Definition Min Value Max Value Unit Code
CRateData C or C-rate is a measure of the rate at which a battery is charged or discharged relative to its capacity. The unit of the C-rate is h−1, equivalent to stating the battery's capacity to store an electrical charge in unit hour times current in the same unit as the charge or discharge current. - - h−1
ElectricChargeData Electric charge data. - - Ah
StateOfChargeData Battery state of charge. - - %
ElectricCurrentData See http://iotschema.org/ElectricCurrentData - - -
VoltageData See http://iotschema.org/VoltageData - - -
TemperatureData See http://iotschema.org/TemperatureData - - -
PowerData Data for the power. - - W

Enumeration or Text Data Types:

Name Data Type Enumeration (comma separated) Values
<camelCaseName> <dataype> -

Boolean Data Types:

Name
ChargingStatusData
LowBatteryData

Date Data Types:

Name
<camelCaseName>

DateTime Data Types:

Name
<camelCaseName>

Time Data Types:

Name
<camelCaseName>

See available schema:DataTypes.

Remarks

See: https://ci.mines-stetienne.fr/seas/ElectricPowerSystemOntology-1.0#ElectricPowerStorageSystem. and https://github.com/openconnectivityfoundation/OCF-oneM2M/blob/master/onem2m.m.battery.json

danicic commented 5 years ago

Resolved.