Skip to content

Commit 6e76ae0

Browse files
danielmuellermadanielmuellerma
committed
updated attribute names
updated attribute names, improved description, updated examples
1 parent 142a237 commit 6e76ae0

1 file changed

Lines changed: 11 additions & 10 deletions

File tree

‎mvr-spec.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1407,10 +1407,10 @@ The defined MVR_JOIN message Attributes are specified in Table 68.
14071407
| -------------- | ----------------------------------- | --------------------------- | ----------------------------------------------------------------------------- |
14081408
| Type | [String](#user-content-attrtype-string) | Not Optional | Defines the type of the message. Should be MVR_JOIN |
14091409
| Provider | [String](#user-content-attrtype-string) | Not Optional | The application name providing MVR Import & Export |
1410-
| StationName | [String](#user-content-attrtype-string) | Not Optional | The Name of the sending station to be shown on the clients UI. |
1410+
| StationName | [String](#user-content-attrtype-string) | Not Optional | The Name of the joining station to be shown on the clients UI. |
14111411
| verMajor | [Integer](#user-content-attrtype-integer) | 0 | It is mandatory to transmit the version of the MVR file that the sender station supports. |
14121412
| verMinor | [Integer](#user-content-attrtype-integer) | 0 | It is mandatory to transmit the version of the MVR file that the sender station supports. |
1413-
| 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 |
1413+
| 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 |
14141414
| 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. | |
14151415

14161416
The defined MVR_JOIN response Attributes are specified in Table 69.
@@ -1423,10 +1423,10 @@ The defined MVR_JOIN response Attributes are specified in Table 69.
14231423
| 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. |
14241424
| Message | [String](#user-content-attrtype-string) | Empty String | Human readable message if there is an error. | |
14251425
| Provider | [String](#user-content-attrtype-string) | Not Optional | The application name providing MVR Import & Export |
1426-
| StationName | [String](#user-content-attrtype-string) | Not Optional | The Name of the receiving station to be shown on the UI. |
1426+
| StationName | [String](#user-content-attrtype-string) | Not Optional | The Name of the station sending the MVR_JOIN response to be shown on the UI. |
14271427
| verMajor | [Integer](#user-content-attrtype-integer) | 0 | It is mandatory to transmit the version of the MVR file that the receiver station supports. |
14281428
| verMinor | [Integer](#user-content-attrtype-integer) | 0 | It is mandatory to transmit the version of the MVR file that the receiver station supports. |
1429-
| 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 |
1429+
| 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 |
14301430
| 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. | |
14311431

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

15081508
The defined MVR_LEAVE response Attributes are specified in Table 71.
15091509

@@ -1586,8 +1586,8 @@ The defined MVR_COMMIT message Attributes are specified in Table 72.
15861586
| 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". |
15871587
| FileSize | [Integer](#user-content-attrtype-integer) | Not Optional | |
15881588
| FileUUID | [UUID](#user-content-attrtype-uuid) | Not Optional | The UUID of the MVR file. Generate a UUID using |
1589-
| 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 |
1590-
| 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* |
1589+
| 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 |
1590+
| 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* |
15911591
| Comment | [String](#user-content-attrtype-string) | | Describes the changes made in this version of the MVR file. |
15921592
| 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. |
15931593

@@ -1610,9 +1610,10 @@ Request:
16101610
"Type": "MVR_COMMIT",
16111611
"verMajor":1,
16121612
"verMinor":6,
1613+
"FileSize":256,
16131614
"FileUUID":"",
1615+
"StationUUID":"4aa291a1-1a62-45fe-aabc-e90e5e2399a8",
16141616
"ForStationsUUID":[],
1615-
"FileSize":256,
16161617
"Comment":"My complete description of what I have changed",
16171618
}
16181619
Response:
@@ -1667,7 +1668,7 @@ The defined MVR_REQUEST message Attributes are specified in Table 74.
16671668
| Type | [String](#user-content-attrtype-string) | Not Optional | Defines the type of the message. Should be MVR_REQUEST- |
16681669
| 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. |
16691670
| 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 |
1670-
| FromStationUUID | Array of [UUID](#user-content-attrtype-uuid) | | The UUID of the station that you want to retrieve the MVR from. |
1671+
| FromStationsUUID | Array of [UUID](#user-content-attrtype-uuid) | | Array with the station UUIDs that you want to retrieve the MVR from. |
16711672

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

@@ -1686,7 +1687,7 @@ Request:
16861687
```
16871688
{
16881689
"Type": "MVR_REQUEST",
1689-
"FromStationUUID":"",
1690+
"StationUUID":"",
16901691
"FileUUID":"",
16911692
}
16921693
```

0 commit comments

Comments
 (0)