Merge pull request #16 from stagetimerio/main

Release v2.2.0

Author: lhermann

.npmrc

@@ -0,0 +1 @@
+@stagetimerio:registry=https://npm.pkg.github.com/

README.md

@@ -3,3 +3,5 @@
 This module lets you remotely control your [Stagetimer.io](https://stagetimer.io/) timers.
 
 See [HELP.md](./companion/HELP.md) for usage instructions.
+
+Module development setup: https://github.com/bitfocus/companion-module-base/wiki

companion/HELP.md

@@ -42,13 +42,13 @@ The following Actions are available:
 **Message actions:**
 
 - **Message: Hide**  
-  Hide a message in the room
+    Hide a message in the room
 - **Message: Show**  
-  Show a message in the room
+    Show a message in the room
 - **Message: Toggle visibility**  
-  Show/hide a message in the room
+    Show/hide a message in the room
 - **Message: Create new message**  
-  Create a new message in the room
+    Create a new message in the room
 
 **Timer actions:**
 
@@ -61,7 +61,7 @@ The following Actions are available:
 - **Timer: Toggle playback**  
     Toggle (start/stop) a specific timer in the room
 - **Timer: Create new timer**  
-  Create a new timer in the room
+    Create a new timer in the room
 
 **Transport actions:**
 
@@ -77,6 +77,8 @@ The following Actions are available:
     Start/stop the highlighted timer in the room
 - **Transport: Stop**  
     Stop the highlighted timer in the room
+- **Transport: Reset**  
+    Reset or restart the currently highlighted timer.
 - **Transport: Subtract time**  
     Subtract an amount of time from the highlighted timer in the room.
 
@@ -112,21 +114,45 @@ The following Actions are available:
 
 ## Variables
 
-- `$(stagetimer:currentTimerAppearance)` -  Timer appearance ([Docs](https://stagetimer.io/docs/using-timers/#timer-appearances))
-- `$(stagetimer:currentTimerDuration)` - Timer duration
-- `$(stagetimer:currentTimerDurationAsMs)` - Timer duration (ms)
-- `$(stagetimer:currentTimerId)` - Timer ID
-- `$(stagetimer:currentTimerName)` - Timer name
-- `$(stagetimer:currentTimerNotes)` - Timer notes
+**Room**
+- `$(stagetimer:roomId)` - Room ID
+- `$(stagetimer:roomName)` - Room name
+- `$(stagetimer:roomTimezone)` - Room timezone ([Docs](https://stagetimer.io/docs/using-timers/#timezones))
+
+**Playback Snapshot**  
+The time display is equal to the Stagetimer output, taking [timer appearance](https://stagetimer.io/docs/using-timers/#timer-appearances) into account ([Docs](https://stagetimer.io/docs/viewer/#3-timer)). The current time remaining is always strictly a countdown.
+
+- `$(stagetimer:timeDisplay)` - Time Display
+- `$(stagetimer:timeDisplayHours)` - Time Display (hours)
+- `$(stagetimer:timeDisplayMinutes)` - Time Display (minutes)
+- `$(stagetimer:timeDisplaySeconds)` - Time Display (seconds)
 - `$(stagetimer:currentTimerRemaining)` - Timer remaining time
 - `$(stagetimer:currentTimerRemainingAsMs)` - Timer remaining time (ms)
 - `$(stagetimer:currentTimerRemainingHours)` - Timer remaining time (hours)
 - `$(stagetimer:currentTimerRemainingMinutes)` - Timer remaining time (minutes)
 - `$(stagetimer:currentTimerRemainingSeconds)` - Timer remaining time (seconds)
+
+**Current Timer**
+- `$(stagetimer:currentTimerId)` - Timer ID
+- `$(stagetimer:currentTimerName)` - Timer name
 - `$(stagetimer:currentTimerSpeaker)` - Timer speaker
-- `$(stagetimer:roomId)` - Room ID
-- `$(stagetimer:roomName)` - Room name
-- `$(stagetimer:roomTimezone)` - Room timezone ([Docs](https://stagetimer.io/docs/using-timers/#timezones))
+- `$(stagetimer:currentTimerNotes)` - Timer notes
+- `$(stagetimer:currentTimerAppearance)` – Timer appearance ([Docs](https://stagetimer.io/docs/using-timers/#timer-appearances))
+- `$(stagetimer:currentTimerStartTime12h)` - Hard start time (12h format, [Docs](https://stagetimer.io/docs/using-timers/#using-the-start-time-properly))
+- `$(stagetimer:currentTimerStartTime24h)`- Hard start time (24h format, [Docs](https://stagetimer.io/docs/using-timers/#using-the-start-time-properly))
+- `$(stagetimer:currentTimerDuration)` - Timer duration
+- `$(stagetimer:currentTimerDurationAsMs)` - Timer duration (ms)
+
+**Next Timer**
+- `$(stagetimer:nextTimerId)` - Timer ID
+- `$(stagetimer:nextTimerName)` - Timer name
+- `$(stagetimer:nextTimerSpeaker)` - Timer speaker
+- `$(stagetimer:nextTimerNotes)` - Timer notes
+- `$(stagetimer:nextTimerAppearance)` – Timer appearance ([Docs](https://stagetimer.io/docs/using-timers/#timer-appearances))
+- `$(stagetimer:nextTimerStartTime12h)` - Hard start time (12h format, [Docs](https://stagetimer.io/docs/using-timers/#using-the-start-time-properly))
+- `$(stagetimer:nextTimerStartTime24h)`- Hard start time (24h format, [Docs](https://stagetimer.io/docs/using-timers/#using-the-start-time-properly))
+- `$(stagetimer:nextTimerDuration)` - Timer duration
+- `$(stagetimer:nextTimerDurationAsMs)` - Timer duration (ms)
 
 ---
 

companion/manifest.json

@@ -3,7 +3,7 @@
   "name": "stagetimer",
   "shortname": "stagetimer",
   "description": "Stagetimer.io module for Companion v3",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "license": "MIT",
   "repository": "git+https://github.com/bitfocus/companion-module-stagetimerio-api.git",
   "bugs": "https://github.com/bitfocus/companion-module-stagetimerio-api/issues",

package.json

@@ -1,19 +1,23 @@
 {
   "name": "stagetimerio-api",
-  "version": "2.1.0",
+  "version": "2.2",
+  "description": "Stagetimer.io module for Companion v3",
   "main": "src/index.js",
   "type": "module",
   "scripts": {
     "lint": "eslint ./src",
     "test": "node --test"
   },
   "license": "MIT",
+  "author": "Lukas Hermann <lukas@stagetimer.io>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/bitfocus/companion-module-stagetimerio-api.git"
   },
   "dependencies": {
-    "@companion-module/base": "~1.6.0",
+    "@companion-module/base": "~1.8.0",
+    "@stagetimerio/shared": "^1.6.4",
+    "@stagetimerio/timeutils": "^1.6.1",
     "socket.io-client": "^4.7.1"
   },
   "devDependencies": {

src/actions.js

@@ -16,6 +16,7 @@ export const actionIdType = {
   start: 'start',
   stop: 'stop',
   start_or_stop: 'start_or_stop',
+  reset: 'reset',
   next: 'next',
   previous: 'previous',
   add_time: 'add_time',
@@ -290,22 +291,28 @@ export function loadActions (instance) {
     // Transport actions
     [actionIdType.start]: {
       name: 'Transport: Start',
-      description: 'Start or resume the highlighted timer in the room',
+      description: 'Start or resume the highlighted timer',
       options: [],
       callback: actionCallback,
     },
     [actionIdType.stop]: {
       name: 'Transport: Stop',
-      description: 'Stop the highlighted timer in the room',
+      description: 'Stop the highlighted timer',
       options: [],
       callback: actionCallback,
     },
     [actionIdType.start_or_stop]: {
       name: 'Transport: Start/stop',
-      description: 'Start/stop the highlighted timer in the room',
+      description: 'Start/stop the highlighted timer',
       options: [],
       callback: actionCallback,
     },
+    [actionIdType.reset]: {
+      name: 'Transport: Reset',
+      description: 'Reset or restart the highlighted timer',
+      options: actionOptions.autostart,
+      callback: actionCallback,
+    },
     [actionIdType.next]: {
       name: 'Transport: Next',
       description: 'Highlight the next timer in the list',

src/assets.js

@@ -68,6 +68,19 @@ function generatePresets () {
           getFeedbackDefaults(feedbackType.isStopped),
         ],
       },
+      {
+        name: 'Reset',
+        actionId: actionIdType.reset,
+        style: {
+          size: '14',
+          text: 'Reset',
+          alignment: 'center:bottom',
+          png64: icons.reset,
+          pngalignment: 'center:top',
+          color: colors.white,
+          bgcolor: colors.black,
+        },
+      },
       {
         name: 'Previous',
         actionId: actionIdType.previous,
@@ -184,11 +197,11 @@ function generatePresets () {
 
     Viewer: [
       {
-        name: 'Time remaining',
+        name: 'Time display',
         actionId: '',
         style: {
-          size: '18',
-          text: `$(stagetimer:${variableType.currentTimerRemaining})`,
+          size: 'auto',
+          text: `$(stagetimer:${variableType.timeDisplay})`,
           color: colors.white,
           bgcolor: colors.black,
         },
@@ -200,11 +213,11 @@ function generatePresets () {
         ],
       },
       {
-        name: 'Time remaining (hours)',
+        name: 'Time display (hours)',
         actionId: '',
         style: {
           size: 'auto',
-          text: `\n$(stagetimer:${variableType.currentTimerRemainingHours})`,
+          text: `\n$(stagetimer:${variableType.timeDisplayHours})`,
           color: colors.white,
           bgcolor: colors.black,
         },
@@ -216,11 +229,11 @@ function generatePresets () {
         ],
       },
       {
-        name: 'Time remaining (minutes)',
+        name: 'Time display (minutes)',
         actionId: '',
         style: {
           size: 'auto',
-          text: `\n$(stagetimer:${variableType.currentTimerRemainingMinutes})`,
+          text: `\n$(stagetimer:${variableType.timeDisplayMinutes})`,
           color: colors.white,
           bgcolor: colors.black,
         },
@@ -232,11 +245,11 @@ function generatePresets () {
         ],
       },
       {
-        name: 'Time remaining (seconds)',
+        name: 'Time display (seconds)',
         actionId: '',
         style: {
           size: 'auto',
-          text: `\n$(stagetimer:${variableType.currentTimerRemainingSeconds})`,
+          text: `\n$(stagetimer:${variableType.timeDisplaySeconds})`,
           color: colors.white,
           bgcolor: colors.black,
         },
@@ -247,7 +260,6 @@ function generatePresets () {
           getFeedbackDefaults(feedbackType.isWarningRed),
         ],
       },
-
       {
         name: 'Wrap-up indicator',
         actionId: '',