A14 - 09212018_ISPDS-C_EUD_ICD_v3_3_final.pdf

Integrated Soldier Power & Data System-Core (ISPDS-C) to End User Device (EUD) Communications

Interface Control Document (ICD)

Version: 3.3

ISPDS-C_EUD_ICD_09212018

30 January 2020

Prepared by:

U.S. Army Natick Soldier Research Development and Engineering Center

Reviewed by:

U.S. Army Product Manager Ground Soldier Systems

Project Manager Close Combat Squad (PM CCS) Product Manager Ground Soldier Systems (PdM GSS)

Attn: SFAE-SDR-CCS-GSS 5966 12th Street, Building 1024

Fort Belvoir, VA 22060

DISTRIBUTION STATEMENT A: Approved for public release; distribution is unlimited.

Table of Contents

1.0 Introduction

2.0 Interfacing between ISPDS-C and EUD

2.1 Communication Protocol

2.2 Communication Encoding

2.3 Source and PAN Port Referencing

2.4 ISPDS-C Command and Response Framing

2.4.1 Command Framing

2.4.2 Response Framing

2.5 Integer Data Representation

2.6 List Representation

2.7 Enumeration

2.8 Bit Fields

3.0 References

4.0 Command, Response and Notification Definitions

4.1 Hub Interface Control Document Compliance

4.2 ISPDS-C HUB Static Information Query

4.3 ISPDS-C HUB Status Query

4.4 Power Source Type Query

4.5 ISPDS-C Hub Power Source Type Information

4.6 ISPDS-C Operating Mode

4.7 ISPDS-C Hub LED Type Query

4.8 LED Brightness Control

4.9 LED Illumination Window Control

4.10 Power Source Information

4.11 Set Smart Battery AtRate

4.12 Set Fuel Cell Operating Mode

4.13 Set Fuel Cell Soft Off

4.14 Primary Source Port Selection

4.15 Select and Query Maximum Power Point Tracking

4.16 PAN Port Information

4.17 PAN Port USB Information

4.18 PAN Port Power and Data Control

4.19 Power Distribution on PAN Port Control

Revision: 3.3

4.20 Set ISPDS-C HUB PAN Port Priority

4.21 PAN Port BIT Query

4.22 Reset to Factory Defaults

4.23 ISPDS-C Alert Notification

4.24 Clear Alert Condition

4.25 Set ALERT Repeat Rate

5.0 Acronym and Definition List

Version Tracking This sheet provides the revision history change record. Each issue of this document, when issued automatically supersedes its predecessor. Refer to Table 1.

TABLE I: ICD Configuration Management Change Record Table

Approved

David Troxel PdM GSS Chief Engineer

Version API Date Pages Description Configuration Management

1 1 11 Dec 2013 Orig. Initial Release based on the AMI Draft ICD Steve Tokish;

Tom Waters;

Casey Alford

2 2 2014 N/A Add Introduction, Required Bits and Communication Protocol Sections

2.3 3 2014 N/A Add Integral Data Representation Section Change BIT_TEST to BIT Change MANUFACTURER to MANUFACTURE Change AT_RATE_TIME_EMPTY to

AT_RATE_TIME_TO_EMPTY

Change AT_RATE_TIME_FULL to

AT_RATE_TIME_TO_FULL

2.4 4 24 Apr 2014 N/A Add Command Response Terminator Add HUB_MODE Command and Response Add MSG_STANDARD_VER Command and Response Remove \0 KVP Terminator

2.5 5 2016 N/A Add HUB Command and Response Changed message framing to use STX/ETX Minor document syntax changes for consistency

3.0 6 16 Nov 2017 N/A Major format change USB messages and Alerts added

3.1 7 14 Jun 2018 N/A Multiple revisions to command and response syntax Dave Schimmel;

Dan Milliken

3.2 8 21 Sep 2018 N/A Rework command and response structure within the document. Add Port and Source parameters to the command and response syntax. Provided details on messaging and new messages for next generation hubs (NGHs).

Dave Schimmel;

Todd Lehn; Dan Milliken; Matt Dinkins; Jose Collazo

3.3 9 23 Oct 2018 Mult. Updated document number Changed SS&I to GSS Changed PM SWAR to PM CCS Entered into PdM GSS Configuration Control

D. Troxel

Document Number:

Integrated Soldier Power & Data System – Core to End User Device Communications Interface Control Document (ICD)

1.0 Introduction

An ISPDS-C (Integrated Soldier Power and Data System-Core) Power Hub connected to an End User Device (EUD) with one or more power sources and optionally, one or more peripheral devices provides the soldier with the capabilities to monitor and control their current power footprint, enabling the soldier to meet their operational requirement and successfully complete the mission.

This document describes the requirements, protocols, message formats, and supported messages for integrated power control and reporting between an End User Device and ISPDS-C Power Hub.

The Jupiter App is an U.S. Army developed graphical user interface Android software application that runs on an EUD host and has a graphical user interface to show users the status of ISPDS-C connected battery(ies) and devices as well as project run time to empty (RTTE) of power sources. The Jupiter App is dependent on the ISPDS-C having appropriate compliant hardware and software/firmware interfaces and attached compliant devices. Data described in this document is consumed by the Jupiter app for display to the user and may be used to support cloud services, predictive analysis, and other functions related to the dismounted Soldier’s power.

1.1 Required Hardware and Software

Minimum required hardware to support interface to Jupiter:

• End User Device (EUD)

• Power and Data Hub

• Power Source

• C1 cables

• EUD Host Select Cable (e.g., C6, C9)

• EUD interface cable (e.g., C7, C7L, C8)

Figure 1: Nett Warrior Dual Radio Configuration with ISPDS-C

Figure 2: Nett Warrior Extended Mission Configuration with Basic Hub

Minimum requirements for Jupiter Android app:

• Android ROM 5.1.1 or later.

• Android kernel capable of charging while in USB host mode.

This document defines many commands that affect the runtime behavior of the ISPDS-C. Default settings and retention of settings are considered a design requirement of the ISPDS-C, and as such, are to be detailed in the appropriate System Functional Specification.

EUD

APP

2.0 Interfacing between ISPDS-C and EUD

2.1 Communication Protocol

When connected, the EUD and ISPDS-C Power Hub communicate via USB with the EUD acting as the USB Host and the ISPDS-C as a USB Hub.

2.2 Communication Encoding

All messages communicated between the EUD and the ISPDS-C shall be encoded as standard ASCII.

2.3 Source and PAN Port Referencing

Source and PAN ports are referenced by an index value. Indexes start at 1 and are constrained with an upper bound defined by the physical properties of the ISPDS-C. For example, an ISPDS-C with 2 source ports and 3 PAN ports would have SRC 1, SRC 2, PAN 1, PAN 2, PAN 3.

2.4 ISPDS-C Command and Response Framing

2.4.1 Command Framing

All commands communicated to the ISPDS-C are comprised of a single line containing a key, optional parameters and are terminated with an ASCII LF (0x0A) character. The key and parameters (when present) are delimited with an ASCII US (0x1F) character. Commands may be issued with 0 or more parameters.

Key LF (0x0A) Command Frame 1 – Without parameter

Key US (0x1F) Value LF (0x0A) Command Frame 2 - With one parameter

Key US (0x1F) Value US (0x1F) Value LF (0x0A) Command Frame 3 - With two parameters

2.4.2 Response Framing

All responses communicated from the ISPDS-C will start with an ASCII STX (0x02) character and terminate with an ASCII ETX (0x03) character. This signifies that the response to the previously issued command is complete and no more data will be returned until the next command (input) is issued.

STX (0x02) Response ETX (0x03)

Response Frame 1

2.4.2.1 Record Framing

All responses communicated from the ISPDS-C will contain one or more records. Each record is comprised of a key and value and is terminated with an ASCII LF (0x0A) character. The record’s key and value are delimited with an ASCII US (0x1F) character.

Key US (0x1F) Value LF (0x0A) Record Frame 1

2.5 Integer Data Representation

All integer values contained in the responses from the ISPDS-C are represented in either base 10 or base

16. All base 16 values are prepended with the 0x notation. If an integral does not contain the 0x notation, it is assumed as base 10.

2.6 List Representation

Lists of type List<type> are defined as a comma delimited set of values. Whitespace shall not precede nor follow the command delimiter.

Example: List<uint8> = 0,1,2,3,4,5,6

2.7 Enumeration

Enumeration is defined as a set of mutually exclusive values, with the values often being of an integer type.

2.8 Bit Fields

Bit fields are used to convey inclusive values through the direct addressing of specific bits in a contiguous block of memory. Bit fields may also be referred to as Bit Flags or just Flags and are denoted with the hexadecimal value required to set the bit value to 1.

3.0 References

Smart Battery Data Specification (SBDS) - Revision 1.1 December 11, 1998 The data elements that are provided by the ISPDS-C Hub to the EUD are, for the most part, identical to those documented in detail in the Smart Battery Data Specification listed above.

SBDS – Addendum For Fuel Cell Systems (SBDS-AFFCS) – Release 1.02 April 11, 2007 The data elements that are provided by the ISPDS-C Hub to the EUD for fuel cell sources are, for the most part, identical to those documented in detail in the SBDS Fuel Cell Addendum listed above.

Semantic Versioning Specification (SemVer) - https://semver.org/ Semantic Versioning defines a common methodology for communication software version information.

https://semver.org/

4.0 Command, Response and Notification Definitions

4.1 Hub Interface Control Document Compliance

Query the ISPDS-C Hub for ICD compliance API version information. This information enables the client applications to dynamically adapt to the messaging API for which the Hub is compliant.

Since API: 8

Parameter: none

Command Frame:

Value Command Terminator

MSG_STANDARD_API 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

API 0x1F uint16 0x0A Reports the ISPDS-C compliant API version.

ETX (0x03)

4.2 ISPDS-C HUB Static Information Query

Query the ISPDS-C for basic information. This information is static and will not change between queries.

Since API: 8

Parameter: None

Command Frame:

Value Command Terminator

HUB_INFORMATION 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

SOFTWARE_VERSION 0x1F Semantic Version

0x0A Reports the ISPDS-C Hub software version in semantic versioning format.

FIRMWARE_VERSION 0x1F Semantic Version

0x0A Reports ISPDS-C Hub firmware version in semantic versioning format.

SOFTWARE_REVISION_DATE 0x1F uint64 0x0A Reports the ISPDS-C software revision date as unix time.

FIRMWARE_REVISION_DATE 0x1F uint64 0x0A Reports the ISPDS-C firmware revision date as unix time.

SRC_COUNT 0x1F uint8 0x0A Reports the number of ISPDS-C SRC ports.

PAN_COUNT 0x1F uint8 0x0A Reports the number of ISPDS-C PAN ports.

LED_ENUMERATIONS 0x1F List<uint8> 0x0A Reports the unique ID value for each ISPDS-C LED. The ID value is used by query and control commands to directly reference the LED.

4.3 ISPDS-C HUB Status Query

Query the ISPDS-C Hub for overall status information.

Since API: 8

Parameter: none

Command Frame:

Value Command Terminator

HUB_INFORMATION 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

UPTIME 0x1F uint64 0x0A Reports the uptime counted as seconds since the ISPDS-C Hub was booted.

SRC_PRIMARY 0x1F uint8 0x0A Reports the current ISPDS-C power source port number.

Range = [1, SRC_COUNT]

INPUT_WATTS 0x1F float32 0x0A Reports the total input power from all SRC ports reported as Watts.

OUTPUT_WATTS 0x1F float32 0x0A Reports the total output power reported as Watts.

I2C_BUS_FAULTS 0x1F uint64 0x0A Reports the total number of I2C bus faults since boot.

PAN_FAULTS 0x1F uint64 0x0A Reports the total number of PAN port faults since boot.

4.4 Power Source Type Query

Query the ISPDS-C Hub to determine if SMBus communication is active for a given SRC port. If SMBus is available, the ISPDS-C Hub responds with additional information gathered from the SMBus device when the power source’s information is queried via the SRC command.

Since API: 8

Parameter: SRC port. The valid parameter range is [1, SRC_COUNT].

Command Frame:

Value Delimiter Parameter Type Command Terminator

SRC_SMBUS 0x1F uint8 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

SRC 0x1F uint8 0x0A Reports the SRC port identification number for which the command and response were issued.

Range = [1, SRC_COUNT]

SMBUS 0x1F uint8 0x0A Reports if SMBus communication is enabled for the SRC port.

SMBUS is one of the following enumerations:

0 = SMBus Not Supported 1 = SMBus Smart Battery 2 = SMBus Fuel Cell

3 – 255 = RESERVED

4.5 ISPDS-C Hub Power Source Type Information

Query the ISPDS-C Hub for power source type information on a source port. The Hub responds with a value from the type enumeration set. The set of types are defined and described as:

• 0 = None – No power source is connected to the source port.

• 1 = Direct Current – A direct current power source is connected to the source port.

• 2 = Primary Battery – A non-rechargeable battery is connected to the source port.

• 3 = Secondary Battery – A rechargeable battery is connected to the source port.

• 4 = Fuel Cell – A fuel cell is connected to the source port.

• 5 – 255 = Reserved – The type is not yet defined by this document.

Since API: 8

Parameter: SRC port: Parameter range is [1, SRC_COUNT].

Command Frame:

Value Delimiter Parameter Type Command Terminator

SRC_TYPE 0x1F uint8 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

SRC 0x1F uint8 0x0A Reports the SRC port identification number for which the command and response were issued.

Range = [1, SRC_COUNT]

TYPE 0x1F uint8 0x0A Reports the power source type for the SRC port.

TYPE is one of the following enumerations:

0 = None

1 = DC

2 = Primary Battery 3 = Secondary Battery 4 = Fuel Cell

5 – 255 = RESERVED

4.6 ISPDS-C Operating Mode

Query the ISPDS-C Hub’s current operating mode. The 4 operating modes are defined and described as:

• 0 = Power and Data – The ISPDS-C Hub is supplying power from one or more power sources to the attached devices and data communication is enabled.

• 1 = Data Only – The ISPDS-C Hub is not supplying power from any of the power sources to the attached devices. Data communication is still enabled.

• 2 = Power and Data Embedded Host – The ISPDS-C Hub is supplying power from one or more power sources to the attached devices and data communication is enabled with the ISPDS-C acting as an Embedded Host.

• 3 = Data Only Embedded Host – The ISPDS-C Hub is not supplying power from any of the power sources to the attached devices. Data communication is still enabled and the ISPDS-C is acting as an Embedded Host.

• 4 – 255 = RESERVED = The operating mode is not yet defined by this document.

Since API: 8

Parameter: none

Command Frame:

Value Command Terminator

MODE 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

MODE 0x1F uint8 0x0A Reports the ISPDS-C operating mode.

Mode is one of the following enumerations:

0 = Power and Data Mode 1 = Data Only Mode 2 = Power and Data Embedded Host Mode 3 = Data Only Embedded Host Mode

4 – 255 = RESERVED

4.7 ISPDS-C Hub LED Type Query

Query the ISPDS-C Hub LED instance for its unique identifier. Some examples of LED indicator are “BATT”, “AUX”, “PAN” and others.

Since API: 8

Parameter: The unique ID of the LED instance which was provided in the LED_ENUMERATIONS field from the ISPDS-C Hub Information Query.

Command Frame:

Value Delimiter Parameter Type Command Terminator

LED_TYPE 0x1F uint8 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

TYPE 0x1F string 0x0A Report the name for the selected LED.

4.8 LED Brightness Control

Controls the brightness of an ISPDS-C Hub LED.

Since API: 8

Parameters:

1. The unique ID of the LED to control

2. Relative brightness on a scale of [0,10] with 0 = Off, 10 = Full Brightness

Command Frame:

Value Delimiter Parameter Type Delimiter Parameter Type Command Terminator

LED_BRIGHTNESS 0x1F uint8 0x1F uint8 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

LED 0x1F uint8 0x0A Reports the LED ID for which the command and response were issued.

BRIGHTNESS 0x1F uint8 0x0A Reports the brightness for the ISPDS-C Hub LED.

Range = [0,10]

4.9 LED Illumination Window Control

Controls the amount of time, in seconds, that ALL ISPDS-C Hub LEDs will illuminate at their set brightness level after the ISPDS-C boots. After the elapsed time, the ISPDS-C Hub will set the brightness of all LEDs to 0 (no light emitted).

After the elapsed time, individual LEDs may be illuminated by controlling their brightness via the LED Brightness Control command.

Since API: 8

Parameter: Amount of time, in seconds, ALL ISPDS-C Hub LEDs will be illuminated after the ISPDS-C has booted. Specify 0 to enable the LEDs indefinitely.

Command Frame:

Value Delimiter Parameter Type Command Terminator

LED_TIME 0x1F uint32 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

TIME 0x1F uint32 0x0A Reports the time, in seconds, the ISPDS-C LEDs will illuminate after the hub has booted.

4.10 Power Source Information

Report power source information available for the specified source. If the power source is SMBus compliant and the ISPDS-C Hub returned active from the HUB_SRC_SMBUS query, the SMBus Compliant Response is returned. This provides additional power source information only available from SMBus compliant sources. If the power source is not SMBus compliant and the HUB_SRC_SMBUS query returned inactive, the alternate response from is returned.

Note: fields are defined in the Smart Battery Data Specification Rev. 1.1 Note: BATTERY_MODE and BATTERY_STATUS data elements are the direct responses from the Smart Battery Specification functions BatteryMode() and BatteryStatus().

Since API: 8

Parameter: SRC port: Parameter range is [1, SRC_COUNT].

Command Frame:

Value Delimiter Parameter Type Command Terminator

SRC 0x1F uint8 0x0A

SMBus Compliant Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

SRC 0x1F uint8 0x0A Reports the SRC port identification number for which the command and response were issued.

Range = [1, SRC_COUNT]

BATTERY_MODE 0x1F uint16 0x0A Reports the 16 bit BatteryMode() word.

Ref.: SBDS §5.1.4

BATTERY_STATUS 0x1F uint16 0x0A Reports the 16 bit BatteryStatus()word.

Ref.: SBDS §5.1.21

VOLTAGE 0x1F uint16 0x0A Reports the cell-pack’s voltage as mV.

Ref.: SBDS §5.1.10

CURRENT 0x1F int16 0x0A Reports the current being supplied (or accepted) as mA.

Ref.: SBDS §5.1.11

AVG_CURRENT 0x1F int16 0x0A Reports a one-minute rolling average of current.

Ref.: SBDS §5.1.12

TEMP 0x1F uint16 0x0A Reports the cell-pack’s internal temperature as tenths of degrees Kelvin.

Ref.: SBDS §5.1.9

FULL_CHARGE_CAPACITY 0x1F uint16 0x0A Returns the predicted pack capacity when it is fully charged.

Ref.: SBDS §5.1.17

REMAINING_CAPACITY 0x1F uint16 0x0A Returns the predicted remaining battery capacity.

Ref.: SBDS §5.1.16

RUN_TIME_TO_EMPTY 0x1F uint16 0x0A Returns the predicted remaining battery life in minutes.

Ref.: SBDS §5.1.18

AVERAGE_TIME_TO_EMPTY 0x1F uint16 0x0A Returns a one-minute rolling average of the predicted remaining battery life (minutes).

Ref.: SBDS §5.1.19

AVERAGE_TIME_TO_FULL 0x1F uint16 0x0A Returns a one-minute rolling average of the predicted remaining time until full charge.

Ref.: SBDS §5.1.20

AT_RATE_TIME_TO_FULL 0x1F uint16 0x0A Returns the predicted time to fully charge the battery with

AT_RATE.

Ref.: SBDS §5.1.6

AT_RATE_TIME_TO_EMPTY 0x1F uint16 0x0A Returns the predicted time to discharge the battery with

AT_RATE.

Ref.: SBDS §5.1.7

AT_RATE_OK 0x1F boolean 0x0A Indicates whether the battery can deliver AT_RATE for 10 seconds.

Ref.: SBDS §5.1.8

MAX_ERROR 0x1F uint8 0x0A Returns the margin of error in state of charge calculations.

Ref.: SBDS §5.1.13

RELSOC 0x1F uint8 0x0A Returns the predicted remaining battery capacity as a percentage of FullChargeCapacity.

Ref.: SBDS §5.1.14

ABSSOC 0x1F uint8 0x0A Returns the predicted remaining battery capacity as a percentage of DesignCapacity.

Ref.: SBDS §5.1.15

CHARGE_VOLTAGE 0x1F uint16 0x0A Returns the battery’s requested charging voltage in mV.

Ref.: SBDS §5.2.2

CHARGE_CURRENT 0x1F uint16 0x0A Returns the battery’s requested charging current in mA.

Ref.: SBDS §5.2.1

CYCLE_COUNT 0x1F uint16 0x0A Returns the number of cycles the battery has experienced.

Ref.: SBDS §5.1.22

Additional fields included if BATTERY_MODE bit 10 is set

DESIGN_MAX_POWER 0x1F uint16 0x0A Returns the maximum current for a fuel cell system.

Ref.: SBDS-AFFCS §5.2.1

START_TIME 0x1F uint16 0x0A Returns the startup time of a fuel cell in seconds.

Ref.: SBDS-AFFCS §5.2.2

TOTAL_RUN_TIME 0x1F uint16 0x0A Returns the total runtime (in hours) over the lifetime of a fuel cell.

Ref.: SBDS-AFFCS §5.2.3

FC_TEMP 0x1F uint16 0x0A Returns the internal temperature of a fuel cell in degrees Celsius.

Ref.: SBDS-AFFCS §5.2.4

FC_STATUS 0x1F uint16 0x0A Communicates various fuel cell status.

Ref.: SBDS-AFFCS §5.2.5

Non-SMBus Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

SRC 0x1F uint8 0x0A Reports the SRC port identification number for which the command and response were issued.

Range = [1, SRC_COUNT]

VOLTAGE 0x1F uint16 0x0A Reports the voltage as mV.

CURRENT 0x1F int16 0x0A Reports the current being supplied (or accepted) as mA.

AVG_CURRENT 0x1F int16 0x0A Reports a one-minute rolling average based on the current being supplied (or accepted) through the battery's terminals as mA.

4.11 Set Smart Battery At Rate

Sets the AtRate value used in calculations made by the AtRateTimeToFull(), AtRateTimeToEmpty(), and AtRateOK() functions as specified in SBDS §5.1.5. This command is only available when the source attached to the SRC port is a smart battery. If the source attached to the SRC port is not a smart battery, the ISPDS-C will ignore this command.

Since API: 8

Parameters:

1. SRC port: Parameter range is [1, SRC_COUNT]

2. AtRate value as specified in SBDS §5.1.5

Command Frame:

Value Delimiter Parameter Type Delimiter Parameter Type Command Terminator

SRC_AT_RATE 0x1F uint8 0x1F int16 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

SRC 0x1F uint8 0x0A Reports the SRC port identification number for which the command and response were issued.

Range = [1, SRC_COUNT]

AT_RATE 0x1F int16 0x0A Returns the AT_RATE value.

Ref.: SBDS §5.1.5

4.12 Set Fuel Cell Operating Mode

Sets the Fuel Cell operating mode in accordance to SBDS-AFFCS §5.2.6. This command is only available when the source attached to the SRC port is a fuel cell. If the source attached to the SRC port is not a fuel cell, the ISPDS-C will ignore this command.

Since API: 8

Parameters:

1. SRC port: Parameter range is [1, SRC_COUNT]

2. Bit mapped integer in accordance to SBDS-AFFCS §5.2.6

Command Frame:

Value Delimiter Parameter Type Delimiter Parameter Type Command Terminator

SRC_FC_MODE 0x1F uint8 0x1F uint16 bit mapped 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

SRC 0x1F uint8 0x0A Reports the SRC port identification number for which the command and response were issued.

Range = [1, SRC_COUNT]

MODE 0x1F uint16 bit mapped 0x0A Returns the Fuel Cell operating mode.

Ref.: SBDS-AFFCS §5.2.7

4.13 Set Fuel Cell Soft Off

Transitions an attached Fuel Cell to Soft Off in accordance to SBDS-AFFCS §5.2.7. This command is only available when the source attached to the SRC port is a fuel cell. If the source attached to the SRC port is not a fuel cell, the ISPDS-C will ignore this command.

Since API: 8

Parameter: SRC port: Parameter range is [1, SRC_COUNT]

Command Frame:

Value Delimiter Parameter Type Command Terminator

SRC_AUTO_SOFT_OFF 0x1F uint8 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

SRC 0x1F uint8 0x0A Reports the SRC port identification number for which the command and response were issued.

Range = [1, SRC_COUNT]

AUTO_SOFT_OFF 0x1F uint16 0x0A Returns the Auto_Soft-OFF value.

Ref.: SBDS-AFFCS §5.2.7

4.14 Primary Source Port Selection

Select the primary power input SRC port. The primary power source provides power to the ISPDS-C Hub PAN Ports (when enabled) and may supply charging power for rechargeable batteries attached to other SRC input ports.

Since API: 8

Parameter: SRC port: Parameter range is [1, SRC_COUNT].

Command Frame:

Value Delimiter Parameter Type Command Terminator

SRC_PRIMARY 0x1F uint8 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

PRIMARY 0x1F uint8 0x0A Reports the primary power SRC port.

Range = [1, SRC_COUNT]

4.15 Select and Query Maximum Power Point Tracking

Specify the Maximum Power Point Tracking (MPPT) type for simple DC sources for a given SRC port.

Optionally, the second parameter may be omitted to query the active MPPT for the given SRC port.

Since API: 8

Parameters:

1. SRC port: Parameter Range is [1, SRC_COUNT]

2. [optional] MPPT Algorithm Enumerations

a. 0 = MPPT Not Active

b. 1 = General (DC sources like vehicle Platform Power or Battery Power) MPPT

c. 2 = Monocrystalline Silicon (M-Si) Solar Panel MPPT

d. 3 = Gallium Arsenide (GaAs) Solar Panel MPPT

e. 4 = Wireless Power Systems (WPS) MPPT

f. 5 = Kinetic System MPPT

g. 6 – 255 = RESERVED

Command Frame:

Value Delimiter Parameter Type Delimiter Parameter Type Command Terminator

SRC_MPTT 0x1F uint8 0x1F uint8 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

SRC 0x1F uint8 0x0A Reports the SRC port identification number for which the command and response were issued.

Range = [1, SRC_COUNT]

MPTT 0x1F uint8 0x0A Report the MPTT state for the SRC port.

MPTT is one of the following enumerations:

0 = MPPT Not Active 1 = General (DC sources like vehicle Platform Power) 2 = Monocrystalline Si MPPT 3 = GaAs MPPT 4 = Wireless Power Systems

MPPT

5 = Kinetic MPPT

6-255 = RESERVED

4.16 PAN Port Information

Reports state (on | off), voltage, current, fault (active, inactive) and SMBus information for the specified PAN port.

Since API: 8

Parameter: PAN port: Parameter range is [1, PAN_COUNT].

Command Frame:

Value Delimiter Parameter Type Command Terminator

PAN 0x1F uint8 0x0A

Response Frame:

Key Delimiter Value Type Record

Delimiter Interpretation

STX (0x02)

PAN 0x1F uint8 0x0A Reports the PAN port identification number for which the command and response were issued.

Range = [1, PAN_COUNT]

STATE 0x1F uint8 0x0A Reports the current state for the PAN port.

State is one of the following enumerations:

0 = ON

1 = Hardware Disabled 2 = User Disabled

3 – 255 = RESERVED

VOLTAGETODEVICE_PIN1 0x1F uint16 0x0A Reports the voltage on Pin 1 of the PAN port in mV.

CURRENTTODEVICE_PIN1 0x1F int16 0x0A Reports the current in mA being supplied through Pin 1 of the PAN port. Positive values represent current being sourced from the Hub.

VOLTAGETODEVICE_PIN3 0x1F uint16 0x0A Reports the voltage on Pin 3 of the PAN port in mV.

CURRENTTODEVICE_PIN3 0x1F int16 0x0A Reports the current in mA being supplied through Pin 3 of the PAN port. Positive values represent current being sourced from the Hub.

VOLTAGETODEVICE_PIN7 0x1F uint16 0x0A Reports the voltage on Pin 7 of the PAN port in mV.

CURRENTTODEVICE_PIN7 0x1F int16 0x0A Reports the current in mA being supplied through Pin 7 of the PAN port. Positive values represent current being sourced from the Hub.

FAULT 0x1F uint8 0x0A Reports if the PAN port is currently in a fault state.

State is one of the following enumerations:

0 = ACTIVE

1 = INACTIVE

2 – 255 = RESERVED

4.17 PAN Port USB Information

Query the USB Device Descriptor of the device connected to the specified PAN port.

Since API: 8

Parameter: PAN port: Parameter range is [1, PAN_COUNT]

Command Frame:

Value Delimiter Parameter Type Command Terminator

PAN_USB_DEVICE_INFO 0x1F uint8 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

PAN 0x1F uint8 0x0A Reports the PAN port identification number for which the command and response were issued.

Range = [1, PAN_COUNT]

USB_ATTACHED 0x1F uint8 0x0A Reports the presence of a USB device attached to the PAN port.

The return value is one of the following enumerations:

0 = No USB device present 1 = USB device present

USB_VENDOR_ID

0x1F uint32 0x0A Reports the Vendor ID of the attached USB device or 0 if no USB device is attached.

USB_PRODUCT_ID

0x1F uint32 0x0A Reports the Product ID of the attached USB device or 0 if no USB device is attached.

USB_MANUFACTURE

0x1F string 0x0A Reports the manufacture’s name of the attached USB device.

USB_PRODUCT

0x1F string 0x0A Reports the product’s name for the attached USB device.

4.18 PAN Port Power and Data Control

Enables or disables both data and charging power on the specified PAN port.

Since API: 8

Parameters:

1) PAN port: Parameter range is [1, PAN_COUNT]

2) State Enumerations defined as follows:

a. 0 = OFF

b. 1 = ON

Command Frame:

Value Delimiter Parameter Type Delimiter Parameter Type Command Terminator

PAN_STATE 0x1F uint8 0x1F uint8 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

PAN 0x1F uint8 0x0A Reports the PAN port identification number for which the command and response were issued.

Range = [1, PAN_COUNT]

STATE

0x1F uint8 0x0A Reports the PAN port’s current ON/OFF state.

State is one of the following enumerations:

0 = OFF

1 = ON

4.19 Power Distribution on PAN Port Control

Enable or disable power distribution on the specified PAN port.

Since API: 8

Parameters:

1) PAN port: Parameter range is [1, PAN_COUNT]

2) Power Control bit fields mapped as follows:

a. PIN 1 Enabled = 0x01

b. PIN 3 Enabled = 0x02

c. PIN 7 Enabled = 0x04

Command Frame:

Value Delimiter Parameter Type Delimiter Parameter Type Command Terminator

PAN_POWER 0x1F uint8 0x1F uint8 bit mapped 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

PAN 0x1F uint8 0x0A Reports the PAN port identification number for which the command and response were issued.

POWER

0x1F uint8 bit mapped

0x0A Reports the PAN port’s current power distribution state on pins 1, 3, 7.

4.20 Set ISPDS-C HUB PAN Port Priority

Set the power distribution priority for each ISPDS-C Hub Pan port. The PAN port with the lowest priority is the first PAN port to have power provided to the attached device disabled, and the PAN port with the highest priority is the last PAN port to have power provided to the attached device enabled. The list of PAN port ID values is sorted highest to lowest priority. Omitted PAN port numbers are prioritized after the specified ports with lower port numbers having higher priority.

Since API: 8

Parameter: List<uint8> (Ordered highest to lowest priority)

Command Frame:

Value Delimiter Parameter Type Command Terminator

PAN_PRIORITY 0x1F List<uint8> 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

PRIORITY 0x1F List<uint8> 0x0A Reports the list of PAN Ports, ordered highest to lowest priority, which represents the ISPDS-C current PAN port priorities.

4.21 PAN Port BIT Query

Query faults for a specific PAN port. Each PAN port may have 0 or more active faults at any given time.

To accommodate this, the command response’s size is dynamic based on the number of faults (see response frame definition). The following defines and describes the available Fault types:

• OVIP (OVER VOLTAGE ON INPUT PIN) – Overvoltage condition exists on one or more of the data input pins for the PAN port.

• UVIP (UNDER VOLTAGE ON INPUT PIN) – Undervoltage condition exists on one or more of the data input pins for the PAN port.

• OCIP (OVER CURRENT ON INPUT PIN) – Overcurrent condition exists on one or more of the data input pins for the PAN port.

• SCIP (SHORT CIRCUIT ON INPUT PIN) – Short circuit condition exists on one or more of the data input pins for the PAN port.

• OVPP (OVER VOLTAGE ON POWER PIN) – Overvoltage condition exists on one or more of the power input pins for the PAN port.

• UVPP (UNDER VOLTAGE ON POWER PIN) – Undervoltage condition exists on one or more of the power input pins for the PAN port.

• OCPP (OVER CURRENT ON POWER PIN) – Overcurrent condition exists on one or more of the power input pins for the PAN port.

• SCPP (SHORT CIRCUIT ON POWER PIN) – Short circuit condition exists on one or more of the power input pins for the PAN port.

Since API: 8

Parameter: PAN port: Parameter range is [1, PAN_COUNT].

Command Frame:

Value Delimiter Parameter Type Command Terminator

BIT 0x1F uint8 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

PAN 0x1F uint8 0x0A Reports the PAN port identification number for which the command and response were issued.

COUNT

0x1F uint16 0x0A Reports the total number of active faults on the PAN port.

This value defines the number of fault values included in the response.

FAULT

Reports an active fault on the PAN port. This field is repeated for each active fault.

Fault is one of the following enumerations:

0 = OVIP

1 = UVIP

2 = OCIP

3 = SCIP

4 = OVPP

5 = UVPP

6 = OCPP

7 = SCPP

8-255 = RESERVED

4.22 Reset to Factory Defaults

Resets the ISPDS-C to its Factory Default Settings.

Since API: 8

Parameter: none

Command Frame:

Value Command Terminator

RESET 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

RESET 0x1F boolean 0x0A Confirms the ISPDS-C Hub was reset to the factory default settings.

4.23 ISPDS-C Alert Notification

Alert messages are messages initiated by the ISPDS-C Hub to notify the client application of events such as fault conditions or configuration changes. Alert messages should be sent synchronously with normal message flow. If the ISPDS-C is in the middle of responding to another command when the alert condition occurs, the alert notification shall wait until the current response completes to send the alert.

Since API: 8

Notification Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

ALERT 0x1F uint16 0x0A Reports the unique ID of the alert. Once the alert has been cleared, the ID value may be reused.

CONDITION

Reports a current (not cleared) ISPDS-C Hub alert.

CONDITION is one of the following enumerations:

0 = CRITICAL_PWR_LEVEL

1 = SOURCE_CONNECT

2 = SOURCE_DISCONNECT

3 = SOURCE_FAULT

4 = PAN_CONNECT

5 = PAN_DISCONNECT

6 = PAN_FAULT

7 = HUB_RESET

8 = PAN_CHECK_INITIATE

9 – 255 = RESERVED

4.24 Clear Alert Condition

Clears the alert specified by the ID value. Once the alert has been cleared and the response has been sent, the alert ID value may be reused in subsequent alert notifications.

Since API: 8

Parameter: Alert ID

Command Frame:

Value Delimiter Parameter Type Command Terminator

ALERT_CLEAR 0x1F uint16 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

ALERT 0x1F uint16 0x0A Reports the unique ID of the cleared alert. The ID value may be reused after the response is sent.

4.25 Set ALERT Repeat Rate

Define the rate, in seconds, alert messages are repeated by the ISPDS-C Hub until the client application sends an ALERT_CLEAR command for the alert. The default value is zero which sets alert messages to not repeat.

Since API: 8

Parameter: Rate in seconds

Command Frame:

Value Delimiter Parameter Type Command Terminator

ALERT_REPEAT 0x1F uint16 0x0A

Response Frame:

Key Delimiter Value Type Record Delimiter Interpretation

STX (0x02)

RATE 0x1F uint16 0x0A Reports the rate, in seconds, alert messages are repeated until an ALERT_CLEAR command is issued for the alert.

5.0 Acronym and Definition List

Name Definition AFFCS Addendum For Fuel Cell Systems API Application Programming Interface APS Alternative Power Source AVG Average BIT Built In Test – System self-diagnostic test.

boolean unsigned 8-bit integer 0 = False, non-zero = True DC Direct Current EUD End User Device – Can be a Smart Phone or other host capable USB Display device ETX End of Text character FC Fuel Cell GaAs Gallium Arsenide (a type of materials used in solar panels) GUI Graphical User Device ICD Interface Control Document ID Identification int8 signed 8-bit integer int16 signed 16-bit integer int32 signed 32-bit integer int64 signed 64-bit integer ISPDS-C Integrated Soldier Power and Data System-Core LED Light Emitting Diode M-Si Monocrystalline Silicon (Solar Panel Material Type) MPPT Maximum Power Point Tracking MSG Message NGH Next Generation Hub NW Nett Warrior OC Open Circuit OCIP Over Current on Input Pin OCPP Over Current on Power Pin OVIP Over Voltage on Input Pin OVPP Over Voltage on Power Pin PAN Personal Area Network PdM GSS Product Manager Ground Soldier Systems PM CCS Project Manager Close Combat Squad RTTE Run-time to Empty SCBDS Smart Battery Data Specification SC Short Circuit SCIP Short Circuit on Input Pin SCPP Short Circuit on Power Pin SemVer Semantic Versioning Si Silicone (as in Monocrystalline Silicone solar panel) SMBus System Management Bus SOC State of Charge SOH State of Health SRC Source STX Start of Text uint8 unsigned 8-bit integer uint16 unsigned 16-bit integer uint32 unsigned 32-bit integer uint64 unsigned 64-bit integer Unix Time System for describing a point in time as the number of seconds that have elapsed since January 1st, 1970 UTC.

USB Universal Serial Bus UVIP Under Voltage on Input Pin UVPP Under Voltage on Power Pin VDC Volts Direct Current WPS Wireless Power System

5.0 Acronym and Definition List