Skip to content

Commit 58a0a21

Browse files
danielmuellermadanielmuellerma
committed
unified StationUUID
improved description of attributes; updated examples
1 parent 10b6057 commit 58a0a21

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

‎mvr-spec.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1395,10 +1395,10 @@ The defined MVR_JOIN message Attributes are specified in Table 68.
13951395
| -------------- | ----------------------------------- | --------------------------- | ----------------------------------------------------------------------------- |
13961396
| Type | [String](#user-content-attrtype-string) | Not Optional | Defines the type of the message. Should be MVR_JOIN |
13971397
| Provider | [String](#user-content-attrtype-string) | Not Optional | The application name providing MVR Import & Export |
1398-
| StationName | [String](#user-content-attrtype-string) | Not Optional | The Name of the sending station to be shown on the clients UI. |
1398+
| StationName | [String](#user-content-attrtype-string) | Not Optional | The Name of the joining station to be shown on the clients UI. |
13991399
| verMajor | [Integer](#user-content-attrtype-integer) | 0 | It is mandatory to transmit the version of the MVR file that the sender station supports. |
14001400
| verMinor | [Integer](#user-content-attrtype-integer) | 0 | It is mandatory to transmit the version of the MVR file that the sender station supports. |
1401-
| 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 |
1401+
| 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 |
14021402
| 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. | |
14031403

14041404
The defined MVR_JOIN response Attributes are specified in Table 69.
@@ -1411,10 +1411,10 @@ The defined MVR_JOIN response Attributes are specified in Table 69.
14111411
| 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. |
14121412
| Message | [String](#user-content-attrtype-string) | Empty String | Human readable message if there is an error. | |
14131413
| Provider | [String](#user-content-attrtype-string) | Not Optional | The application name providing MVR Import & Export |
1414-
| StationName | [String](#user-content-attrtype-string) | Not Optional | The Name of the receiving station to be shown on the UI. |
1414+
| StationName | [String](#user-content-attrtype-string) | Not Optional | The Name of the station sending the MVR_JOIN response to be shown on the UI. |
14151415
| verMajor | [Integer](#user-content-attrtype-integer) | 0 | It is mandatory to transmit the version of the MVR file that the receiver station supports. |
14161416
| verMinor | [Integer](#user-content-attrtype-integer) | 0 | It is mandatory to transmit the version of the MVR file that the receiver station supports. |
1417-
| 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 |
1417+
| 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 |
14181418
| 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. | |
14191419

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

14961496
The defined MVR_LEAVE response Attributes are specified in Table 71.
14971497

@@ -1574,7 +1574,7 @@ The defined MVR_COMMIT message Attributes are specified in Table 72.
15741574
| 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". |
15751575
| FileSize | [Integer](#user-content-attrtype-integer) | Not Optional | |
15761576
| FileUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | The UUID of the MVR file. Generate a UUID using |
1577-
| 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 |
1577+
| 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 |
15781578
| 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* |
15791579
| Comment | [String](#user-content-attrtype-string) | | Describes the changes made in this version of the MVR file. |
15801580
| 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. |
@@ -1598,9 +1598,10 @@ Request:
15981598
"Type": "MVR_COMMIT",
15991599
"verMajor":1,
16001600
"verMinor":6,
1601+
"FileSize":256,
16011602
"FileUUID":"",
1603+
"StationUUID":"4aa291a1-1a62-45fe-aabc-e90e5e2399a8",
16021604
"ForStationsUUID":[],
1603-
"FileSize":256,
16041605
"Comment":"My complete description of what I have changed",
16051606
}
16061607
Response:
@@ -1654,7 +1655,7 @@ The defined MVR_REQUEST message Attributes are specified in Table 74.
16541655
| -------------- | ----------------------------------- | --------------------------- | ----------------------------------------------------------------------------- |
16551656
| Type | [String](#user-content-attrtype-string) | Not Optional | Defines the type of the message. Should be MVR_REQUEST- |
16561657
| 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. |
1657-
| FromStationUUID | Array of [UUID](#user-content-attrtype-uuid) | | The UUID of the station that you want to retrieve the MVR from. |
1658+
| StationUUID | Array of [UUID](#user-content-attrtype-uuid) | | The UUID of the station that you want to retrieve the MVR from. |
16581659

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

@@ -1673,7 +1674,7 @@ Request:
16731674
```
16741675
{
16751676
"Type": "MVR_REQUEST",
1676-
"FromStationUUID":"",
1677+
"StationUUID":"",
16771678
"FileUUID":"",
16781679
}
16791680
```

0 commit comments

Comments
 (0)