Add files via upload

Author: mko1989

companion/HELP.md

@@ -0,0 +1,87 @@
+# Bosch Dicentis Companion Module
+
+#### Config
+- **Transport**: Select `DICENTIS API (WebSocket)` for server API or `DICENTIS Wireless (REST)` for DCNM-WAP HTTP API
+- **Server IP**: IP address of the Bosch Dicentis server
+- **REST Port / Protocol**: Used in REST mode (defaults: `80`, `http`)
+- **REST Login Path**: Login endpoint used in REST mode (default: `/api/login`)
+- **REST Command Path**: Command endpoint used for operation payloads in REST mode (default: `/api`)
+- **Username**: Login credentials for API access
+- **Password**: Authentication password
+
+##### User Credentials
+You need to add a user in Dicentis meeting application and give the user permissions, you can also log in as default admin as well. 
+The permissions of logged in user will appear in log for viewing.
+
+#### Debug Messages
+- Enable debug messages to track WebSocket connections, API interactions, and system events
+- Debug logs provide detailed information about:
+  - WebSocket connection status
+  - Authentication attempts
+  - API request and response details
+  - Microphone state changes
+  - Permission validation
+- Useful for troubleshooting connection issues, permission problems, and unexpected system behavior
+
+#### Variables
+- `$(dicentis:{seatName_screenLine})`: seatId - gives seatId of each seat for internal processing and for further possibilities to interact with triggers
+- `$(dicentis:Active_Microphone_screenLine)`: Indicates the active microphone's screenLine
+- `$(dicentis:Active_Microphone_screenName)`: Indicates the active microphone's screenName
+
+
+#### Actions
+- Toggle microphone for each seat
+- Activate/Deactivate individual microphones
+- Activate/Deactivate interpreter desks
+- Custom command for testing purposes
+- REST Request (GET/POST/PUT/DELETE with optional JSON body) for wireless REST API endpoints
+
+#### Permissions
+
+`canManageMeeting`
+ In order to have canManageMeeting permission, web client seat needs to have Manage Meeting rights and logged in user needs to have activate meeting rights or logged in Participant needs to have manage meeting.
+ 
+`canControlInterpretation`
+ In order to have canControlInterpretation permission, web client seat needs to have Manage Meeting rights, system should have special licenses, premium licenses or ultimate licenses and logged in user needs to have ActivateMeeting or logged in participant needs to have manage meeting.
+ 
+`canEditSynoptic`
+ In order to have canEditSynoptic permission, logged in user needs to have ConfigureSystem rights.
+ 
+`canSelect`
+ In order to have canSelect permission, logged in user needs to have ConfigureSystem rights.
+ 
+`canAddDevicesToSeats`
+ In order to have canAddDevicesToSeats permission, logged in user needs to have ConfigureSystem rights.
+ 
+`canViewVoting`
+ In order to have canViewVoting permission, system should have special licenses, premium licenses or ultimate licenses, the synoptic seat needs to have Can Vote, and Voting Scripts should be configured to have rights for External System.
+ 
+`canEnableSeatIllumination`
+ In order to have canEnableSeatIllumination permission, logged in user needs to have ConfigureSystem rights.
+ 
+`canSwitchSystemPowerOn`
+ In order to have canSwitchSystemPowerOn, web client seat needs to have Power On rights. Logged in participant needs to have manage meeting rights.
+ 
+`canSwitchSystemPowerOff`
+ In order to have canSwitchSystemPowerOff, web client seat needs to have Power Off rights. Logged in participant needs to have manage meeting rights.
+ 
+`canViewRequestItems`
+ In order to have canViewRequestItems, logged-in user either needs to have Manage Meeting rights or logged-in user needs to have Special permission.
+ 
+`canViewFirstRequestOnSeat`
+ In order to have canViewRequestItems, logged in user either needs to have Manage Meeting rights or logged-in user needs to have Special permission.
+ 
+`canDeactivateMicrophone`
+ This permission only gets enabled in Response mode, logged in user needs to have Manage rights.
+ 
+`hasSpecialPermission`
+ In order to have hasSpecialPermission. Web client seat needs to have special permission.
+ 
+`canViewInterpretation`
+ In order to have canViewInterpretation, Logged in user either needs to have Activate meeting rights. Logged in participant needs to have Manage Meeting rights.
+ 
+`canControlMasterVolume`
+ In order to have canControlMasterVolume, web client seat needs to have Volume Control rights. Logged in user either needs to have Activate meeting rights. Logged in participant needs to have Manage Meeting rights.
+ 
+`canControlVoting`
+ In order to have canControlVoting, system should have LVPM license, web client seat needs to have Voting Control rights. Logged in user needs to have Activate meeting rights. Logged in participant needs to have Manage Meeting rights and Vote rights.