Conversation
raffael0
approved these changes
Mar 28, 2026
There was a problem hiding this comment.
Pull request overview
Updates the Field Registration & Management specification to remove ambiguity about how parameter vs telemetry field IDs are distinguished (bit position), improving interoperability across implementations.
Changes:
- Clarifies that the most significant bit of the field ID distinguishes parameters (0) from telemetry values (1).
- Minor formatting/line adjustments in the “Field name Lookup” subsection.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| After registration was initialized, a node sends out \texttt{field\_registration} messages, one for each | ||
| parameter/telemetryValue. The FieldRegistration includes a field ID, the datatype of the field, and | ||
| a human-readable name. The name and field ID have to be unique per node. The first bit of paramter field IDs is 0 and the first bit of telemetryValue field IDs is 1. From this point on, the server knows which fields the node has. The fieldID \texttt{0} is reserved to indicate an invalid fieldID. It must not be assigned to a field. FieldIDs must be assigned in a determenistic way. This ensures that named fields have the same fieldID between reboots. | ||
| a human-readable name. The name and field ID have to be unique per node. The most significant bit of paramter field IDs is 0 and the most significant bit of telemetryValue field IDs is 1. From this point on, the server knows which fields the node has. The fieldID \texttt{0} is reserved to indicate an invalid fieldID. It must not be assigned to a field. FieldIDs must be assigned in a determenistic way. This ensures that named fields have the same fieldID between reboots. |
There was a problem hiding this comment.
Typo: "determenistic" should be "deterministic".
Suggested change
| a human-readable name. The name and field ID have to be unique per node. The most significant bit of paramter field IDs is 0 and the most significant bit of telemetryValue field IDs is 1. From this point on, the server knows which fields the node has. The fieldID \texttt{0} is reserved to indicate an invalid fieldID. It must not be assigned to a field. FieldIDs must be assigned in a determenistic way. This ensures that named fields have the same fieldID between reboots. | |
| a human-readable name. The name and field ID have to be unique per node. The most significant bit of paramter field IDs is 0 and the most significant bit of telemetryValue field IDs is 1. From this point on, the server knows which fields the node has. The fieldID \texttt{0} is reserved to indicate an invalid fieldID. It must not be assigned to a field. FieldIDs must be assigned in a deterministic way. This ensures that named fields have the same fieldID between reboots. |
|
|
||
| \subsubsection{Field name Lookup}\label{subsubsec:field-name-lookup} | ||
| The field name lookup covers the case where nodes need to access fields from other nodes. Since they don't recieve the \texttt{field\_registration} messages, they don't know the fieldIDs of the named fields they want to access. \texttt{field\_id\_lookup\_req} messages contain the remote field name. The Node responds with a \texttt{field\_id\_lookup\_res} message, containing the fieldID, the datatype of the field, and a field status (see FieldStatus enum in \ref{subsec:FieldStatus}). If the field is not found (field\_status = NotFound), the field\_id should still contain the requested field ID from the request message. No newline at end of file | ||
| The field name lookup covers the case where nodes need to access fields from other nodes. Since they don't recieve the \texttt{field\_registration} messages, they don't know the fieldIDs of the named fields they want to access. \texttt{field\_id\_lookup\_req} messages contain the remote field name. The Node responds with a \texttt{field\_id\_lookup\_res} message, containing the fieldID, the datatype of the field, and a field status (see FieldStatus enum in \ref{subsec:FieldStatus}). If the field is not found (field\_status = NotFound), the field\_id should still contain the requested field ID from the request message. |
There was a problem hiding this comment.
Typo: "recieve" should be "receive".
| After registration was initialized, a node sends out \texttt{field\_registration} messages, one for each | ||
| parameter/telemetryValue. The FieldRegistration includes a field ID, the datatype of the field, and | ||
| a human-readable name. The name and field ID have to be unique per node. The first bit of paramter field IDs is 0 and the first bit of telemetryValue field IDs is 1. From this point on, the server knows which fields the node has. The fieldID \texttt{0} is reserved to indicate an invalid fieldID. It must not be assigned to a field. FieldIDs must be assigned in a determenistic way. This ensures that named fields have the same fieldID between reboots. | ||
| a human-readable name. The name and field ID have to be unique per node. The most significant bit of paramter field IDs is 0 and the most significant bit of telemetryValue field IDs is 1. From this point on, the server knows which fields the node has. The fieldID \texttt{0} is reserved to indicate an invalid fieldID. It must not be assigned to a field. FieldIDs must be assigned in a determenistic way. This ensures that named fields have the same fieldID between reboots. |
There was a problem hiding this comment.
Typo: "paramter" should be "parameter".
Suggested change
| a human-readable name. The name and field ID have to be unique per node. The most significant bit of paramter field IDs is 0 and the most significant bit of telemetryValue field IDs is 1. From this point on, the server knows which fields the node has. The fieldID \texttt{0} is reserved to indicate an invalid fieldID. It must not be assigned to a field. FieldIDs must be assigned in a determenistic way. This ensures that named fields have the same fieldID between reboots. | |
| a human-readable name. The name and field ID have to be unique per node. The most significant bit of parameter field IDs is 0 and the most significant bit of telemetryValue field IDs is 1. From this point on, the server knows which fields the node has. The fieldID \texttt{0} is reserved to indicate an invalid fieldID. It must not be assigned to a field. FieldIDs must be assigned in a determenistic way. This ensures that named fields have the same fieldID between reboots. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.