Identify a Version for the Protocol, Visibility for Minor and Breaking Changes

[ForrestErickson]

The GPAD API identifies information to be exchanged between multiple systems.
Changes to the information content and format, AKA protocol will break systems.
To manage confusion, the protocol must be identified by a version.
Visibility to minor changes is important to persons testing features our bug fixes.
Visibility to major changes will be important to developers of other products.

[ForrestErickson]

As of 20260221 the GPAD_API in Krake supports only the commands parsed in the file GPAD_HAL.cpp in the switch command at line 434

and enumerated as follows

  enum class Command : char
  {
    MUTE = 's',
    UNMUTE = 'u',
    HELP = 'h',
    ALARM = 'a',
    INFO = 'i',
  };

[ForrestErickson]

Semantic Versioning 2.0.0

I recommend adoption of Semantic Versioning for GPAP.
See this document for a good definition of Semantic Versioning 2.0.0 | Semantic Versioning https://share.google/I37VcfeMomXB7M0vG

GPAD_API

Please note that the GPAD_API "i" command now returns a protocol version in this form.

As of 20240224 the Krake reports:
GPAD API Version: 0.1.0

CC:
@nk25719
@TheBakedPotato

[TheBakedPotato]

Best source source for Semantic Versioning is the official site. As well, Wikipedia gives a nice summary about it.

But yes, for a public API, I would definitely agree that semantic versioning be followed. It will make much easier for relying parties (the Krake and ADaM at the moment) for ensuring the other party is speaking the same language. If either system is having issues it will be much easier to determine why.