Skip to content

MVR-xchange: updated attribute names for StationUUID #284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danielmuellerma wants to merge 1 commit into
base: next
Choose a base branch
from
Open

MVR-xchange: updated attribute names for StationUUID #284

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions mvr-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1407,10 +1407,10 @@ The defined MVR_JOIN message Attributes are specified in Table 68.
| -------------- | ----------------------------------- | --------------------------- | ----------------------------------------------------------------------------- |
| Type | [String](#user-content-attrtype-string) | Not Optional | Defines the type of the message. Should be MVR_JOIN |
| Provider | [String](#user-content-attrtype-string) | Not Optional | The application name providing MVR Import & Export |
| StationName | [String](#user-content-attrtype-string) | Not Optional | The Name of the sending station to be shown on the clients UI. |
| StationName | [String](#user-content-attrtype-string) | Not Optional | The Name of the joining station to be shown on the clients UI. |
| verMajor | [Integer](#user-content-attrtype-integer) | 0 | It is mandatory to transmit the version of the MVR file that the sender station supports. |
| verMinor | [Integer](#user-content-attrtype-integer) | 0 | It is mandatory to transmit the version of the MVR file that the sender station supports. |
| StationUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | UUID of sending station inside the network. This UUID should be persistent across multiple start-ups of the same software on the same computer |
| StationUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | UUID of the joining station inside the network. This UUID should be persistent across multiple start-ups of the same software on the same computer |
| Commits | [Array of `MVR_COMMIT`](#user-content-attrtype-string) | Empty Array | List all available MVR files that are on sender station in the format of the `MVR_COMMIT` packet. | |

The defined MVR_JOIN response Attributes are specified in Table 69.
Expand All @@ -1423,10 +1423,10 @@ The defined MVR_JOIN response Attributes are specified in Table 69.
| OK | [Bool](#user-content-attrtype-bool) | Not Optional | True when operation is successful, false when there is an error. Check the Message for more information in this case. |
| Message | [String](#user-content-attrtype-string) | Empty String | Human readable message if there is an error. | |
| Provider | [String](#user-content-attrtype-string) | Not Optional | The application name providing MVR Import & Export |
| StationName | [String](#user-content-attrtype-string) | Not Optional | The Name of the receiving station to be shown on the UI. |
| StationName | [String](#user-content-attrtype-string) | Not Optional | The Name of the station sending the MVR_JOIN response to be shown on the UI. |
| verMajor | [Integer](#user-content-attrtype-integer) | 0 | It is mandatory to transmit the version of the MVR file that the receiver station supports. |
| verMinor | [Integer](#user-content-attrtype-integer) | 0 | It is mandatory to transmit the version of the MVR file that the receiver station supports. |
| StationUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | UUID for receiving station inside the network. This UUID should be persistent across multiple start-ups of the same software on the same computer |
| StationUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | UUID of the station sending the MVR_JOIN response inside the network. This UUID should be persistent across multiple start-ups of the same software on the same computer |
| Commits | [Array of `MVR_COMMIT`](#user-content-attrtype-string) | Empty Array | List all available MVR files that are on receiver station in the format of the `MVR_COMMIT` packet. | |

EXAMPLE
Expand Down Expand Up @@ -1503,7 +1503,7 @@ The defined MVR_LEAVE message Attributes are specified in Table 70.
| Attribute Name | Attribute Value Type | Default Value when Optional | Description |
| -------------- | ----------------------------------- | --------------------------- | ----------------------------------------------------------------------------- |
| Type | [String](#user-content-attrtype-string) | Not Optional | Defines the type of the message. Should be MVR_LEAVE |
| FromStationUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | The UUID of the station. |
| StationUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | The UUID of the leaving station. |

The defined MVR_LEAVE response Attributes are specified in Table 71.

Expand Down Expand Up @@ -1586,8 +1586,8 @@ The defined MVR_COMMIT message Attributes are specified in Table 72.
| verMinor | [Integer](#user-content-attrtype-integer) | Not Optional | It is mandatory to transmit the current version of the MVR file as specified in Root File. If joining as new member send "0". |
| FileSize | [Integer](#user-content-attrtype-integer) | Not Optional | |
| FileUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | The UUID of the MVR file. Generate a UUID using |
| StationUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | UUID for the station inside the network. This UUID should be persistent across multiple start-ups of the same software on the same computer |
| ForStationsUUID | Array of [UUID](#user-content-attrtype-uuid) | [] | Array with the station UUID that this MVR should be send to. When it is an empty array, the MVR will be send to all connected *MVR-xchange clients* |
| StationUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | UUID of the station sending the commit inside the network. This UUID should be persistent across multiple start-ups of the same software on the same computer |
| ForStationsUUID | Array of [UUID](#user-content-attrtype-uuid) | [] | Array with the station UUIDs that this MVR should be send to. When it is an empty array, the MVR will be send to all connected *MVR-xchange clients* |
| Comment | [String](#user-content-attrtype-string) | | Describes the changes made in this version of the MVR file. |
| FileName | [String](#user-content-attrtype-string) | | Describes the file name that can be used to store the file on disk to preserve it across multiple MVR-xchange clients. The usage of this attribute is optional, when not defined, the receiving MVR-xchange client can decide which file name it uses to store it on disk. |

Expand All @@ -1610,9 +1610,10 @@ Request:
"Type": "MVR_COMMIT",
"verMajor":1,
"verMinor":6,
"FileSize":256,
"FileUUID":"",
"StationUUID":"4aa291a1-1a62-45fe-aabc-e90e5e2399a8",
"ForStationsUUID":[],
"FileSize":256,
"Comment":"My complete description of what I have changed",
}
Response:
Expand Down Expand Up @@ -1667,7 +1668,7 @@ The defined MVR_REQUEST message Attributes are specified in Table 74.
| Type | [String](#user-content-attrtype-string) | Not Optional | Defines the type of the message. Should be MVR_REQUEST- |
| FileUUID | [UUID](#user-content-attrtype-uuid) | Last MVR File from station | The UUID of the requested MVR file. If not set, the last available file is sent. |
| StationUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | UUID for the station inside the network. This UUID should be persistent across multiple start-ups of the same software on the same computer |
| FromStationUUID | Array of [UUID](#user-content-attrtype-uuid) | | The UUID of the station that you want to retrieve the MVR from. |
| FromStationsUUID | Array of [UUID](#user-content-attrtype-uuid) | | Array with the station UUIDs that you want to retrieve the MVR from. |

The defined MVR_REQUEST error response Attributes are specified in Table 75.

Expand All @@ -1686,7 +1687,7 @@ Request:
```
{
"Type": "MVR_REQUEST",
"FromStationUUID":"",
"StationUUID":"",
"FileUUID":"",
}
```
Expand Down