frodovdr/hyperion.ng
1
0
Fork 0
mirror of https://github.com/hyperion-project/hyperion.ng.git synced 2025-03-01 10:33:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Support direct or multiple instance addressing via single requests

Browse Source
This commit is contained in:
LordGrey
2024-04-29 20:34:15 +02:00
parent e01e3e70a0
commit 722d6d7ad5
17 changed files with 255 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
doc/development/JSON-API _Commands_Overview.md
View File

@@ -13,6 +13,7 @@ _Authorization (via password or bearer token)_
_Instance specific_
**Yes** - A specific instance can be addressed<br>
**Multi** - Multiple instances can be addressed via one request<br>
**No** - The command is not instance related
_http/s Support_
@@ -20,73 +21,73 @@ _http/s Support_
**Yes** - Command can be used by individual http/s requests<br>
**No** - Applies only to WebSocket or http/s sessions
| Command | Sub-Command | Authorization | Instance specifc | http/s Support |
|:---------------|-------------------------|:--------------|:-----------------|:---------------|
| adjustment | - | Yes | Yes | Yes |
| authorize | adminRequired | No | No | Yes |
| authorize | answerRequest | Admin | No | No |
| authorize | createToken | Admin | No | No |
| authorize | deleteToken | Admin | No | Yes |
| authorize | getPendingTokenRequests | Admin | No | No |
| authorize | getTokenList | Admin | No | Yes |
| authorize | login | No | No | No |
| authorize | logout | No | No | No |
| authorize | newPassword | Admin | No | Yes |
| authorize | newPasswordRequired | No | No | Yes |
| authorize | renameToken | Admin | No | Yes |
| authorize | requestToken | No | No | Yes |
| authorize | tokenRequired | No | No | Yes |
| clear | - | Yes | Yes | Yes |
| clearall | - | Yes | Yes | Yes |
| color | - | Yes | Yes | Yes |
| componentstate | - | Yes | Yes | Yes |
| config | getconfig | Admin | Yes | Yes |
| config | getschema | Admin | Yes | Yes |
| config | reload | Admin | Yes | Yes |
| config | restoreconfig | Admin | Yes | Yes |
| config | setconfig | Admin | Yes | Yes |
| correction | - | Yes | Yes | Yes |
| create-effect | - | Yes | Yes | Yes |
| delete-effect | - | Yes | Yes | Yes |
| effect | - | Yes | Yes | Yes |
| image | - | Yes | Yes | Yes |
| inputsource | discover | Yes | No | Yes |
| inputsource | getProperties | Yes | No | Yes |
| instance | createInstance | Admin | No | Yes |
| instance | deleteInstance | Admin | No | Yes |
| instance | saveName | Admin | No | Yes |
| instance | startInstance | Yes | No | Yes |
| instance | stopInstance | Yes | No | Yes |
| instance | switchTo | Yes | No | Yes |
| ledcolors | imagestream-start | Yes | Yes | Yes |
| ledcolors | imagestream-stop | Yes | Yes | Yes |
| ledcolors | ledstream-start | Yes | Yes | Yes |
| ledcolors | ledstream-stop | Yes | Yes | Yes |
| leddevice | addAuthorization | Yes | Yes | Yes |
| leddevice | discover | Yes | Yes | Yes |
| leddevice | getProperties | Yes | Yes | Yes |
| leddevice | identify | Yes | Yes | Yes |
| logging | start | Yes | No | Yes |
| logging | stop | Yes | No | Yes |
| processing | - | Yes | Yes | Yes |
| serverinfo | - | Yes | Yes | Yes |
| serverinfo | getInfo | Yes | Yes | Yes |
| serverinfo | subscribe | Yes | Yes | No |
| serverinfo | unsubscribe | Yes | Yes | No |
| serverinfo | getSubscriptions | Yes | Yes | No |
| serverinfo | getSubscriptionCommands | No | No | No |
| service | discover | Yes | No | Yes |
| sourceselect | - | Yes | No | Yes |
| sysinfo | - | Yes | No | Yes |
| system | restart | Yes | No | Yes |
| system | resume | Yes | No | Yes |
| system | suspend | Yes | No | Yes |
| system | toggleSuspend | Yes | No | Yes |
| system | idle | Yes | No | Yes |
| system | toggleIdle | Yes | No | Yes |
| temperature | - | Yes | Yes | Yes |
| transform | - | Yes | Yes | Yes |
| videomode | - | Yes | No | Yes |
| Command | Sub-Command | Authorization | Instance specific | http/s Support |
|:---------------|:------------------------|:--------------|:------------------|:---------------|
| adjustment | - | Yes | Multi | Yes |
| authorize | adminRequired | No | No | Yes |
| authorize | answerRequest | Admin | No | No |
| authorize | createToken | Admin | No | No |
| authorize | deleteToken | Admin | No | Yes |
| authorize | getPendingTokenRequests | Admin | No | No |
| authorize | getTokenList | Admin | No | Yes |
| authorize | login | No | No | No |
| authorize | logout | No | No | No |
| authorize | newPassword | Admin | No | Yes |
| authorize | newPasswordRequired | No | No | Yes |
| authorize | renameToken | Admin | No | Yes |
| authorize | requestToken | No | No | Yes |
| authorize | tokenRequired | No | No | Yes |
| clear | - | Yes | Multi | Yes |
| clearall | - | Yes | Multi | Yes |
| color | - | Yes | Multi | Yes |
| componentstate | - | Yes | Multi | Yes |
| config | getconfig | Admin | Yes | Yes |
| config | getschema | Admin | Yes | Yes |
| config | reload | Admin | Yes | Yes |
| config | restoreconfig | Admin | Yes | Yes |
| config | setconfig | Admin | Yes | Yes |
| correction | - | Yes | Yes | Yes |
| create-effect | - | Yes | Yes | Yes |
| delete-effect | - | Yes | Yes | Yes |
| effect | - | Yes | Multi | Yes |
| image | - | Yes | Multi | Yes |
| inputsource | discover | Yes | No | Yes |
| inputsource | getProperties | Yes | No | Yes |
| instance | createInstance | Admin | No | Yes |
| instance | deleteInstance | Admin | No | Yes |
| instance | saveName | Admin | No | Yes |
| instance | startInstance | Yes | No | Yes |
| instance | stopInstance | Yes | No | Yes |
| instance | switchTo | Yes | No | Yes |
| ledcolors | imagestream-start | Yes | Yes | Yes |
| ledcolors | imagestream-stop | Yes | Yes | Yes |
| ledcolors | ledstream-start | Yes | Yes | Yes |
| ledcolors | ledstream-stop | Yes | Yes | Yes |
| leddevice | addAuthorization | Yes | Yes | Yes |
| leddevice | discover | Yes | Yes | Yes |
| leddevice | getProperties | Yes | Yes | Yes |
| leddevice | identify | Yes | Yes | Yes |
| logging | start | Yes | No | Yes |
| logging | stop | Yes | No | Yes |
| processing | - | Yes | Multi | Yes |
| serverinfo | - | Yes | Yes | Yes |
| serverinfo | getInfo | Yes | Yes | Yes |
| serverinfo | subscribe | Yes | Yes | No |
| serverinfo | unsubscribe | Yes | Yes | No |
| serverinfo | getSubscriptions | Yes | Yes | No |
| serverinfo | getSubscriptionCommands | No | No | No |
| service | discover | Yes | No | Yes |
| sourceselect | - | Yes | Multi | Yes |
| sysinfo | - | Yes | No | Yes |
| system | restart | Yes | No | Yes |
| system | resume | Yes | No | Yes |
| system | suspend | Yes | No | Yes |
| system | toggleSuspend | Yes | No | Yes |
| system | idle | Yes | No | Yes |
| system | toggleIdle | Yes | No | Yes |
| temperature | - | Yes | Yes | Yes |
| transform | - | Yes | Yes | Yes |
| videomode | - | Yes | No | Yes |
## Subscription updates