touchpanel-ui-microservice

A microservice for the touchpanel UI containing both Blueberry and Cherry. Blueberry and Cherry are the interfaces written in Angular. Provides room control for AV devices and camera control through a touch screen display on a raspberry pi. Angular specific testing information can be found in the README.md in /cherry.

Endpoints

Status

GET /status
- Returns: bin, statuscode, version, uptime, websocket info

Log Events

POST /publish
- Send a log event to the event bus

Websocket

GET /websocket
- Websocket endpoint for the UI
PUT /screenoff
- Sends a screenoff message to the UI, only Blueberry seems to have a significant response
PUT /refresh
- Refreshes the UI app
PUT /socketTest
- Sends the message "socket test" to the UI

UI Endpoints

GET /pihostname
GET /hostname
GET /deviceinfo
GET /reboot
GET /uiconfig
- Returns the UI config
GET /uipath
- Gets the UI Config and then returns the path for the url to where the UI is hosted
- Ex: "hostname": "/cherry?1.1.15=BDumwFSa"

GET /api
- Gets the UI Config and then returns the hostname
GET /nextapi
GET /control-key/:room/:controlGroup
- Returns the camera control key for the specified room and control group
POST /help
- Sends a help request event with device info
POST /confirmhelp
POST /cancelhelp

GET /themeconfig
- Returns the theme config to set css values and related theme variables in the UI
GET /logo
- Returns the logo for the UI that is displayed on the standby screen
GET /blueberry/db/:attachment
GET /cherry/db/:attachment

Environment Variables

PI_HOSTNAME
- Ex: PI_HOSTNAME=JET-1234-PI1
SYSTEM_ID
- Ex: SYSTEM_ID="JET-1234-PI1"
DB_ADDRESS
- CouchDB address
DB_USERNAME
- CouchDB Username
DB_PASSWORD
- CouchDB Password
STOP_REPLICATION (boolean)
- Stop replication of CouchDB
HUB_ADDRESS

Hostname/SystemID should be set according to the documentation.

UI Config (Cherry)

Lists the devices and features for the room. Configures what options and devices appear in the UI. Provides endpoints for camera control if applicable. Holds the name of the theme document in CouchDB. If the theme is not found, the UI will look for a theme called "default".

{
    "_id": "JET-1234",
    "api": [
        "localhost"
    ],
    "panels": [
        {
            "hostname": "JET-1234-PI1",
            "uipath": "/cherry",
            "preset": "JET 1234",
            "features": [],
            "theme": "jetTheme"
        }
    ],
    "presets": [
        {
            "name": "JET 1234",
            "icon": "videocam",
            "displays": [
                "D1",
                "D2"
            ],
            "shareablePresets": null,
            "shareableDisplays": null,
            "audioDevices": [
                "D1"
            ],
            "inputs": [
                "PC1",
                "ATV1",
                "HDMI1",
                "HDMI2"
            ],
            "commands": {
                "powerOn": [
                    {
                        "method": "PUT",
                        "port": 5858,
                        "endpoint": "buildings/JET/rooms/1234",
                        "body": {
                            "audioDevices": [
                                {}
                            ]
                        }
                    }
                ]
            },
            "screens": null,
            "cameras": [
                {
                    "displayName": "Camera",
                    "tiltUp": "https://cameras.example.com/JET-1234-CAM.example.com:22000/pantilt/up",
                    "tiltDown": "https://cameras.example.com/JET-1234-CAM.example.com:22000/pantilt/down",
                    "panLeft": "https://cameras.example.com/JET-1234-CAM.example.com:22000/pantilt/left",
                    "panRight": "https://cameras.example.com/JET-1234-CAM.example.com:22000/pantilt/right",
                    "panTiltStop": "https://cameras.example.com/JET-1234-CAM.example.com:22000/pantilt/stop",
                    "zoomIn": "https://cameras.example.com/JET-1234-CAM.example.com:22000/zoom/in",
                    "zoomOut": "https://cameras.example.com/JET-1234-CAM.example.com:22000/zoom/out",
                    "zoomStop": "https://cameras.example.com/JET-1234-CAM.example.com:22000/zoom/stop",
                    "presets": [
                        {
                            "displayName": "Room",
                            "setPreset": "https://cameras.example.com/JET-1234-CAM.example.com:22000/preset/0"
                        }
                    ]
                }
            ],
            "recording": {
                "start": "http://localhost:2024/192.168.0.56/JET1234JACK1/volume/mute",
                "stop": "http://localhost:2024/192.168.0.56/JET1234JACK1/volume/unmute",
                "maxTime": 120
            }
        }
    ],
    "inputConfiguration": [
        {
            "name": "ATV1",
            "icon": "settings_input_antenna"
        },
        {
            "name": "HDMI1",
            "icon": "settings_input_hdmi"
        },
        {
            "name": "HDMI2",
            "icon": "settings_input_hdmi"
        },
        {
            "name": "PC1",
            "icon": "desktop_windows"
        },
        {
            "name": "CLEVERTOUCH",
            "icon": "android"
        }
    ],
    "outputConfiguration": [
        {
            "name": "C1",
            "icon": "videocam"
        },
        {
            "name": "C2",
            "icon": "videocam"
        }
    ],
    "audioConfiguration": []
}

Theme Configuration (Cherry)

Configures the appearance of the UI through CSS variables. Gives control over setting the font and allows for the standby screen logo to be uploaded as an attachment in Couch called logo.svg.

{
  "_id": "JET-1234",
  "_rev": "7-85d0a5e2bfe58b92c8edbd43a017945b",
  "background-color": "#633834",
  "top-bar-color": "#2e2322",
  "background-color-accent": "#de5a4d",
  "dpad-color": "#e3e3e3",
  "dpad-press": "#777777",
  "cam-preset-color": "#455a64",
  "cam-preset-press": "orange",
  "show-cam-text": true,
  "phone-number": "801-422-7671",
  "cam-link": "cameras.example.com",
  "volume-slider-color": "#20956b",
  "help-button-color": "#214e4b",
  "text-color": "white",
  "font-link": "https://cdn.example.com/theme-fonts/1.x.x/ringside/fonts.css",
  "font-name": "HCo Ringside Narrow SSm",
  "_attachments": {
    "logo.svg": {
      "content_type": "image/svg+xml",
      "revpos": 3,
      "digest": "md5-JcROa8W/ytaYTyB47XprDg==",
      "length": 9622,
      "stub": true
    }
  }
}

CouchDB Structure

Databases
├─theme-configuration
| ├── default
| ├── jetTheme
|
├─ui-configuration
| ├── JET-1234   
| ├── BLDG-1235

# README