harp-tech / protocol

Description of the Harp protocol.
https://harp-tech.org/protocol/BinaryProtocol-8bit.html
MIT License
3 stars 5 forks source link

Add Tag register to protocol #38

Open bruno-f-cruz opened 4 months ago

bruno-f-cruz commented 4 months ago

Summary

This PR adds a new register to the protocol called Tag. This new register should be used to optionally keep information regarding a specific tag of a firmware version. A simple use case would be to keep track of a development version of a given minor release.

Motivation

During development it is often the case that intermediate firmware versions are released. These are impossible to track in the firmware as the protocol only specifies a major and minor version. This new register is added to meet this need. Users can use this register to add a "build" or "preview" tag to the firmware, for instance the git commit that generated the release.

Detailed Design

A new register will be added with the following specs:

Name: Tag Address: 17 Format: U8[8] Access: Read-only

Design Meetings

See further discussion in the following issues: