Merge pull request #48 from uw-asa/develop

Update to support Mazevo - Version For Release: 3.2

Author: shadowimmage

README.md

@@ -23,33 +23,14 @@ Note: If you're using Linux Bash for Windows, [see this guide](https://www.howto
 
 Sample configuration file provided in `sample.env`
 
-- `WIW_API_TOKEN=when-i-work-login-token`
-
-  Sets the login token for the When I Work API. Necessary to load any data from When I Work.
-
-- `WIW_API_URL=https://api.wheniwork.com/2/`
-
-  Base URL for When I Work's API. Shouldn't change too much.
-
-- `EMS_API_USER=username`
-
-  Username to pass to EMS for accessing the API.
-
-- `EMS_API_PASS=password`
-
-  Password to pass to EMS for accessing the API.
-
-- `EMS_API_URL=https://base.url/EMSAPI/`
-
-  Root URL for the EMSAPI.
-
-- `NOTES_TITLE_SEPARATOR=-`
+#### Layout and Display Settings
 
-  Titles for events are in the notes for shifts in When I Work for our particular environment. This is subject to change, and thus the separator can be configured. Works in concert with `SEPARATOR_WHITESPACE`.
+- `DISPLAY_PX_X=1920`
+- `DISPLAY_PX_Y=1080`
 
-- `SEPARATOR_WHITESPACE=true`
-
-  Configures whether or not the separator is surrounded by whitespace or not. In this example the above separator would be a dash surrounded by whitespace.
+  Optional. Device-specific Display specification. Used when creating the display window to ensure
+  it's the appropriate size for the attached display. Only needed if the machine cannot determine the
+  display dimensions on it's own.
 
 - `MAX_REFRESH_INTERVAL=300`
 
@@ -63,6 +44,7 @@ Sample configuration file provided in `sample.env`
   - LABOR = When I Work Labor (condensed view)
   - EVENTS = When I Work labor events associated with an event
   - EMS-EVENTS = Events scheduled in EMS (regardless of labor assignment)
+  - MZV-EVENTS = Events scheduled in Mazevo
 
   When both Left and Right render modes are the same, the screen will render data across both columns (top to bottom, left to right). When the settings are different, each column will render it's data in the set column only (top-to-bottom).
 
@@ -75,6 +57,16 @@ Sample configuration file provided in `sample.env`
 
   Sets the display title in the corner of the screen. Defaults to 'Events Display'.
 
+#### API Data Source: When I Work
+
+- `WIW_API_TOKEN=when-i-work-login-token`
+
+  Sets the login token for the When I Work API. Necessary to load any data from When I Work.
+
+- `WIW_API_URL=https://api.wheniwork.com/2/`
+
+  Base URL for When I Work's API. Shouldn't change too much.
+
 - `WIW_API_LOCATION=123456`
 
   API Location ID to search When I Work for shift data. Can be set to a comma-delimited list, such as `123456,234567,345678` to get shifts for multiple locations at once.
@@ -83,30 +75,82 @@ Sample configuration file provided in `sample.env`
 
   How many days worth of data to query from the API each time. Defaults to 7.
 
+- `LABOR_MODE_CUSTOM_NAMING=123456:Event,234567:Office`
+
+  Naming to differentiate When I Work locations from each other when using the 'LABOR' layout, which has shifts in a condensed form.
+
+- `NOTES_TITLE_SEPARATOR=-`
+
+  Titles for events are in the notes for shifts in When I Work for our particular environment. This is subject to change, and thus the separator can be configured. Works in concert with `SEPARATOR_WHITESPACE`.
+
+- `SEPARATOR_WHITESPACE=true`
+
+  Configures whether or not the separator is surrounded by whitespace or not. In this example the above separator would be a dash surrounded by whitespace.
+
+#### API Data Source: EMS
+
+- `EMS_API_USER=username`
+
+  Username to pass to EMS for accessing the API.
+
+- `EMS_API_PASS=password`
+
+  Password to pass to EMS for accessing the API.
+
+- `EMS_API_URL=https://base.url/EMSAPI/`
+
+  Root URL for the EMSAPI.
+
 - `EMS_LOOKAHEAD_DAYS=5`
 
   How many days worth of data to query from the API each time. Defaults to 7.
 
 - `EMS_BUILDINGS=1,2,3,4`
 
-  Building IDs in EMS to gather booking / event data for.
+  Building IDs in EMS to gather booking / event data for. Comma-separated, no whitespace.
 
 - `EMS_STATUSES=2,3,4,5`
 
-  Status IDs in EMS to gather booking / event data for.
+  Status IDs in EMS to gather booking / event data for. Comma-separated, no whitespace.
 
 - `EMS_EVENT_TYPES=1,2,3,4,5,6,7,8,9`
 
-  Event Type IDs in EMS to gather booking / event data for.
+  Event Type IDs in EMS to gather booking / event data for. Comma-separated, no whitespace.
 
-- `LABOR_MODE_CUSTOM_NAMING=123456:Event,234567:Office`
-
-  Naming to differentiate When I Work locations from each other when using the 'LABOR' layout, which has shifts in a condensed form.
-  
 - `EMS_Status_ROW_HIGHLIGHT=2:#ffffff50,3:#aabbccdd`
 
   Set row highlight colors (HEXA) (hex w/ alpha) associated event status ID (ID first). Applies to EMS event date list only. Separate each state setting from the color value by commas (`,`). Separate status ID and color code by colons (`:`).
 
+#### API Data Source: Mazevo
+
+- `MZV_API_URL=https://mazevo_public_API_URL/api/`
+
+  Mazevo URL to gather data from.
+
+- `MZV_API_KEY=somehexstring`
+
+  Mazevo API Key. Generated on the Mazevo Web console.
+
+- `MZV_LOOKAHEAD_DAYS=5`
+
+  How many days worth of data to query from the API each time. Defaults to 7.
+
+- `MZV_BUILDINGS=1,2,3,4`
+
+  Building IDs in Mazevo to gather booking / event data for. Comma-separated, no whitespace.
+
+- `MZV_STATUSES=2,3,4,5`
+
+  Status IDs in Mazevo to gather booking / event data for. Comma-separated, no whitespace.
+
+- `MZV_EVENT_TYPES=1,2,3,4,5,6,7,8,9`
+
+  Event Type IDs in Mazevo to gather booking / event data for. Comma-separated, no whitespace.
+
+- `MZV_ROOMS=1,24,86`
+
+  Room IDs from Mazevo to gather booking / event data for. Comma-separated, no whitespace.
+
 ## Updates
 
 Dependency updates: update the base image in `Dockerfile` and update application dependencies in `package.json`.
@@ -133,21 +177,23 @@ Use Ensure files are up to date and that you are on the correct code branch. Run
 2. Log into the Balena console with `balena login`
 3. Build the image
 
-> `balena build --fleet [BALENA FLEET NAME] --logs .`
+> `balena build --fleet [BALENA FLEET NAME] .`
 
 **Note(s):** Don't forget the trailing `.` which designates the current directory as the source for the code. Substitute in the name of your fleet for `[BALENA FLEET NAME]` which corresponds to the application name on the Balena Cloud dashboard. Add `--logs` to see the complete build details. For complete CLI documentation and other options see the [Balena CLI documentation][2].
 
 4. Push the built image to Balena Cloud
 
 > `balena deploy [BALENA FLEET NAME]`
 
-### Building with Balena Cloud
+### Building with Balena Cloud (Recommended)
+
+This method tends to be more reliable and avoids local problems dependent on docker desktop being installed.
 
 1. Open a console to the project root (where `Dockerfile.template` and `package.json` are)
 2. Log into the Balena console with `balena login`
 3. Push code to Balena's build servers and wait for the image to be deployed automatically
 
-> `balena push [BALENA FLEET NAME] .`
+> `balena push [BALENA FLEET NAME]`
 
 ## Resources for Learning Electron
 

main.js

@@ -75,7 +75,9 @@ const { getWiwSchedule } = require('./utils/fetchWiwSchedule');
 const getEmsSchedule = require('./utils/fetchEmsSchedule');
 const markupEventShiftResults = require('./utils/renderEventShifts');
 const markupLaborResults = require('./utils/renderLaborCondensed');
-const markupEventListResults = require('./utils/renderEventList');
+const markupEmsEventListResults = require('./utils/renderEmsEventList');
+const { getMazevoSchedule } = require('./utils/fetchMazevoSchedule');
+const markupMzvEventListResults = require('./utils/renderMazevoEventList');
 
 // pull in template renderers
 const dualSourceTemplate = pug.compileFile('./templates/body2column-DualSource.pug');
@@ -173,7 +175,11 @@ function determineSideModeRenderFunctions(modeSetting, SETTINGS_DATA_MAPPING, AC
   }
   if (SETTINGS_DATA_MAPPING[modeSetting] === 'EMS' && modeSetting === ACCEPTABLE_SETTINGS[2]) {
     // set EMS events list
-    return [getEmsSchedule, markupEventListResults];
+    return [getEmsSchedule, markupEmsEventListResults];
+  }
+  if (SETTINGS_DATA_MAPPING[modeSetting] === 'MZV' && modeSetting === ACCEPTABLE_SETTINGS[3]) {
+    // set Mazevo Events List
+    return [getMazevoSchedule, markupMzvEventListResults];
   }
   throw new Error('Mode setting error; unable to determine mode setting from env vars.');
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "when-i-work-events-shifts-display",
-  "version": "3.1.1",
-  "description": "Shift display for Events Services, pulling data from the When I Work API",
+  "version": "3.2.0",
+  "description": "Shift display for Events Services, pulling data from When I Work, EMS, or Mazevo",
   "main": "main.js",
   "scripts": {
     "start": "electron .",
@@ -18,7 +18,8 @@
     "digital",
     "signage",
     "wheniwork",
-    "ems"
+    "ems",
+    "mazevo"
   ],
   "author": "Chase Sawyer",
   "license": "MIT",

preload.js

@@ -18,15 +18,17 @@ const {
 let renderModeSingle = true;
 
 // Configure rendering mode and constants for control:
-// options for DISPLAY_RENDER_MODEs: "LABOR", "EVENTS", or "EMS-EVENTS"
+// options for DISPLAY_RENDER_MODEs: "LABOR", "EVENTS", "EMS-EVENTS", or "MZV-EVENTS"
 // LABOR = When I Work Labor (condensed view)
 // EVENTS = When I Work labor events associated with an event
 // EMS-EVENTS = Events scheduled in EMS (regardless of labor assignment)
-const ACCEPTABLE_SETTINGS = ['LABOR', 'EVENTS', 'EMS-EVENTS'];
+// MZV-EVENTS = Events scheduled in Mazevo (regardless of labor assignment)
+const ACCEPTABLE_SETTINGS = ['LABOR', 'EVENTS', 'EMS-EVENTS', 'MZV-EVENTS'];
 const SETTINGS_DATA_MAPPING = {
   LABOR: 'WIW',
   EVENTS: 'WIW',
   'EMS-EVENTS': 'EMS',
+  'MZV-EVENTS': 'MZV',
 };
 if (DISPLAY_RENDER_MODE_LEFT !== DISPLAY_RENDER_MODE_RIGHT) {
   renderModeSingle = false;

static/css/content.css

@@ -24,20 +24,25 @@
 }
 
 td.time-width {
-/*   min-width: 60px; */
+  min-width: 72px;
+  /* width: 80px; */
+}
+
+td.event-title {
+  width: 100%;
 }
 
 td.room-code {
-/*   min-width: 75px; */
+   min-width: 75px;
 }
 
 td.event-title {
   /* min-width: 475px; */
-  /* max-width: 475px; */
+  max-width: 475px;
   white-space: nowrap;
   overflow: hidden;
   text-overflow: ellipsis;
-  max-width: 100%;
+  /* max-width: 100%; */
 }
 
 #reload-interval {

templates/eventDateCard.pug

@@ -8,19 +8,15 @@ div(class='card mx-0 mx-lg-2 p-0 d-inline-block w-100 eventDateCard')
           if event.now
             tr(style=`background-color: ${event.highlight ? event.highlight : '#00000000'}`).fw-bold.shift-item
               td.d-table-cell.room-code #{event.room}
-                div.d-block.d-lg-none #{event.bookStart}
               td.d-table-cell.text-truncate.event-title #{event.title}
-                div.d-block.d-lg-none #{event.bookEnd}
               td.time-width.d-none.d-lg-table-cell #{event.bookStart}
               td.time-width.d-none.d-lg-table-cell #{event.eventStart}
               td.time-width.d-none.d-lg-table-cell #{event.eventEnd}
               td.time-width.d-none.d-lg-table-cell #{event.bookEnd}
           else
             tr(style=`background-color: ${event.highlight ? event.highlight : '#00000000'}`).shift-item
               td.d-table-cell.room-code #{event.room}
-                div.d-block.d-lg-none #{event.bookStart}
               td.d-table-cell.text-truncate.event-title #{event.title}
-                div.d-block.d-lg-none #{event.bookEnd}
               td.time-width.d-none.d-lg-table-cell #{event.bookStart}
               td.time-width.d-none.d-lg-table-cell #{event.eventStart}
               td.time-width.d-none.d-lg-table-cell #{event.eventEnd}