Skip to content

Commit

Permalink
docs: Some bad links in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
svrooij committed Feb 13, 2024
1 parent 5ed07a1 commit 6f5e233
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 112 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Check-out the (generated) documentation about all the SONOS UPNP services [svroo

### Manually documented

The [sonos services](https://svrooij.io/sonos-api-docs/services/) have no documentation, that is why we manually created a [documentation.json](http://svrooij.io/sonos-api-docs/documentation.json) file. To easily add documentation to all services (that are generated with the generator). And it's json so you can easily use it yourself.
The [sonos services](https://sonos.svrooij.io/services/) have no documentation, that is why we manually created a [documentation.json](https://github.com/svrooij/sonos-api-docs/blob/main/docs/documentation.json) file. To easily add documentation to all services (that are generated with the generator). And it's json so you can easily use it yourself.

### Device discovery files

Expand Down Expand Up @@ -81,7 +81,6 @@ specification. Contributions of any kind welcome!
[badge_sponsor]: https://img.shields.io/github/sponsors/svrooij?logo=github&style=for-the-badge
[badge_twitter]: https://img.shields.io/twitter/follow/svrooij?logo=twitter&style=for-the-badge


[link_sponsor]: https://github.com/sponsors/svrooij
[link_issues]: https://github.com/svrooij/sonos-api-docs/issues
[link_sonos-cli]: https://github.com/svrooij/sonos-cli
Expand Down
29 changes: 2 additions & 27 deletions generator/sonos-docs/data/sonos-S1-2.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"model": "S1",
"modelDescription": "Sonos Play:1",
"softwareGeneration": 2,
"softwareVersion": "72.2-40060",
"discoveryDate": "2023-05-22T16:39:21.190Z",
"softwareVersion": "77.4-49290",
"discoveryDate": "2024-02-13T15:56:06.184Z",
"services": [
{
"name": "AlarmClock",
Expand Down Expand Up @@ -2396,11 +2396,6 @@
"name": "FavoritesUpdateID",
"dataType": "string",
"sendEvents": true
},
{
"name": "FavoritePresetsUpdateID",
"dataType": "string",
"sendEvents": true
}
],
"actions": [
Expand Down Expand Up @@ -2758,11 +2753,6 @@
"dataType": "string",
"sendEvents": true
},
{
"name": "HTFreq",
"dataType": "ui4",
"sendEvents": true
},
{
"name": "HTBondedZoneCommitState",
"dataType": "ui4",
Expand Down Expand Up @@ -2971,11 +2961,6 @@
"dataType": "boolean",
"sendEvents": false
},
{
"name": "HTForwardEnabled",
"dataType": "boolean",
"sendEvents": false
},
{
"name": "A_ARG_TYPE_RoomDetectionChirpChannel",
"dataType": "ui2",
Expand Down Expand Up @@ -3368,16 +3353,6 @@
}
]
},
{
"name": "GetHTForwardState",
"outputs": [
{
"name": "IsHTForwardEnabled",
"direction": "out",
"relatedStateVariableName": "HTForwardEnabled"
}
]
},
{
"name": "SetButtonLockState",
"inputs": [
Expand Down
29 changes: 2 additions & 27 deletions generator/sonos-docs/data/sonos-S18-2.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"model": "S18",
"modelDescription": "Sonos One",
"softwareGeneration": 2,
"softwareVersion": "72.2-40060",
"discoveryDate": "2023-05-22T16:38:38.243Z",
"softwareVersion": "77.4-49290",
"discoveryDate": "2024-02-13T15:55:36.464Z",
"services": [
{
"name": "AlarmClock",
Expand Down Expand Up @@ -2396,11 +2396,6 @@
"name": "FavoritesUpdateID",
"dataType": "string",
"sendEvents": true
},
{
"name": "FavoritePresetsUpdateID",
"dataType": "string",
"sendEvents": true
}
],
"actions": [
Expand Down Expand Up @@ -2758,11 +2753,6 @@
"dataType": "string",
"sendEvents": true
},
{
"name": "HTFreq",
"dataType": "ui4",
"sendEvents": true
},
{
"name": "HTBondedZoneCommitState",
"dataType": "ui4",
Expand Down Expand Up @@ -2971,11 +2961,6 @@
"dataType": "boolean",
"sendEvents": false
},
{
"name": "HTForwardEnabled",
"dataType": "boolean",
"sendEvents": false
},
{
"name": "A_ARG_TYPE_RoomDetectionChirpChannel",
"dataType": "ui2",
Expand Down Expand Up @@ -3368,16 +3353,6 @@
}
]
},
{
"name": "GetHTForwardState",
"outputs": [
{
"name": "IsHTForwardEnabled",
"direction": "out",
"relatedStateVariableName": "HTForwardEnabled"
}
]
},
{
"name": "SetButtonLockState",
"inputs": [
Expand Down
29 changes: 2 additions & 27 deletions generator/sonos-docs/data/sonos-S33-2.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"model": "S33",
"modelDescription": "SYMFONISK Bookshelf",
"softwareGeneration": 2,
"softwareVersion": "72.2-40060",
"discoveryDate": "2023-05-22T16:39:16.679Z",
"softwareVersion": "77.4-49290",
"discoveryDate": "2024-02-13T15:55:24.423Z",
"services": [
{
"name": "AlarmClock",
Expand Down Expand Up @@ -2396,11 +2396,6 @@
"name": "FavoritesUpdateID",
"dataType": "string",
"sendEvents": true
},
{
"name": "FavoritePresetsUpdateID",
"dataType": "string",
"sendEvents": true
}
],
"actions": [
Expand Down Expand Up @@ -2758,11 +2753,6 @@
"dataType": "string",
"sendEvents": true
},
{
"name": "HTFreq",
"dataType": "ui4",
"sendEvents": true
},
{
"name": "HTBondedZoneCommitState",
"dataType": "ui4",
Expand Down Expand Up @@ -2971,11 +2961,6 @@
"dataType": "boolean",
"sendEvents": false
},
{
"name": "HTForwardEnabled",
"dataType": "boolean",
"sendEvents": false
},
{
"name": "A_ARG_TYPE_RoomDetectionChirpChannel",
"dataType": "ui2",
Expand Down Expand Up @@ -3368,16 +3353,6 @@
}
]
},
{
"name": "GetHTForwardState",
"outputs": [
{
"name": "IsHTForwardEnabled",
"direction": "out",
"relatedStateVariableName": "HTForwardEnabled"
}
]
},
{
"name": "SetButtonLockState",
"inputs": [
Expand Down
4 changes: 2 additions & 2 deletions generator/sonos-docs/data/sonos-S5-1.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"model": "S5",
"modelDescription": "Sonos Play:5",
"softwareGeneration": 1,
"softwareVersion": "57.15-39070",
"discoveryDate": "2023-05-22T16:39:34.654Z",
"softwareVersion": "57.19-49220",
"discoveryDate": "2024-02-13T15:56:10.829Z",
"services": [
{
"name": "AlarmClock",
Expand Down
29 changes: 2 additions & 27 deletions generator/sonos-docs/data/sonos-S9-2.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"model": "S9",
"modelDescription": "Sonos Playbar",
"softwareGeneration": 2,
"softwareVersion": "72.2-40060",
"discoveryDate": "2023-05-22T16:38:57.120Z",
"softwareVersion": "77.4-49290",
"discoveryDate": "2024-02-13T15:55:46.307Z",
"services": [
{
"name": "AlarmClock",
Expand Down Expand Up @@ -2396,11 +2396,6 @@
"name": "FavoritesUpdateID",
"dataType": "string",
"sendEvents": true
},
{
"name": "FavoritePresetsUpdateID",
"dataType": "string",
"sendEvents": true
}
],
"actions": [
Expand Down Expand Up @@ -2758,11 +2753,6 @@
"dataType": "string",
"sendEvents": true
},
{
"name": "HTFreq",
"dataType": "ui4",
"sendEvents": true
},
{
"name": "HTBondedZoneCommitState",
"dataType": "ui4",
Expand Down Expand Up @@ -2971,11 +2961,6 @@
"dataType": "boolean",
"sendEvents": false
},
{
"name": "HTForwardEnabled",
"dataType": "boolean",
"sendEvents": false
},
{
"name": "A_ARG_TYPE_RoomDetectionChirpChannel",
"dataType": "ui2",
Expand Down Expand Up @@ -3368,16 +3353,6 @@
}
]
},
{
"name": "GetHTForwardState",
"outputs": [
{
"name": "IsHTForwardEnabled",
"direction": "out",
"relatedStateVariableName": "HTForwardEnabled"
}
]
},
{
"name": "SetButtonLockState",
"inputs": [
Expand Down

0 comments on commit 6f5e233

Please sign in to comment.