Merge pull request #7 from stagetimerio/main

Release v2.0.0: Full rewrite of module for Companion v3 and Stagetimer API v1

.gitignore

@@ -1,2 +1,10 @@
+# nodejs
 node_modules/
-package-lock.json
+package-lock.json
+
+# companion
+/pkg
+/pkg.tgz
+
+# other
+.DS_Store

CHANGELOG.md

@@ -1,6 +1,10 @@
-# 1.0.0 (2021-11-16)
+# Changelog
 
+## 2.0.0 (2023-07-05)
 
-### Features
+New Stagetimer.io module for Companion, rewritten from scratch for Companion v3.
+Uses the new Stagetimer.io API v1.
 
-* add initial actions and presets ([aedc551](https://github.com/bitfocus/companion-module-hermann-stagetimerio/commit/aedc55146a0a8ea7c04dc464c4606c5313116dd0))
+## 1.0.0 (2021-11-16)
+
+Initial version of Stagetimer.io module for Companion.

LICENSE

@@ -1,5 +1,21 @@
-Copyright 2021 Johnny Estilles <[email protected]>
+MIT License
 
-Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+Copyright (c) 2022 Bitfocus AS - Open Source
 
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,9 +1,5 @@
-# companion-module-hermann-stagetimerio
+# companion-module-stagetimerio-api
 
-![Build](https://img.shields.io/github/workflow/status/bitfocus/companion-module-hermann-stagetimerio/Release)
-![Version](https://img.shields.io/github/package-json/v/bitfocus/companion-module-hermann-stagetimerio)
-[![Compatibility](https://img.shields.io/badge/compabibility-Stagetimer%20API%20v0-blue)](https://stagetimer.io/docs/api/)
+This module lets you remotely control your [Stagetimer.io](https://stagetimer.io/) timers.
 
-This module will allow you to control your [Stagetimer.io](https://stagetimer.io/) using the [Stagetimer API](https://stagetimer.io/docs/api/).
-
-See [HELP.md](./HELP.md) and [LICENSE](./LICENSE)
+See [HELP.md](./companion/HELP.md) for usage instructions.

companion/HELP.md

@@ -0,0 +1,106 @@
+![Stagetimer.io logo](https://stagetimer.io/assets/logo-full-dark.svg)
+
+# Stagetimer.io module for Companion
+
+This module lets you remotely control [Stagetimer](https://stagetimer.io/) using Companion.
+
+It connects using the [Stagetimer HTTP RPC API](https://stagetimer.io/docs/api-v1) and [Stagetimer Socket.io endpoint](https://stagetimer.io/docs/api-v1/#socket-io-endpoint).
+
+## Requirements
+
+To use this module you need:
+
+- A Stagetimer account on a **paid plan** (*Pro* or *Premium*).
+- **Room ID**: The ID of the Stagetimer room you want to control.
+- **API Key**: A key that authorizes you to use the Stagetimer API. You can generate an API key on the controller page.
+
+## Configuration
+
+1. Click on the module in the Connections list to reveal the configuration pane.
+2. Enter your **Room ID** and **API Key** in the form and click *Save*.
+3. If the details you entered are correct, the module will connect. If the module fails to connect, please review the output in the Companion Logs tab.
+
+## Presets
+
+There are multiple presets available for the most common actions, ready to drop into  your button layout.
+
+## Actions
+
+The following Actions are available:
+
+- **Message: Hide**  
+    Hide a message in the room
+- **Message: Show**  
+    Show a message in the room
+- **Message: Toggle visibility**  
+    Show/hide a message in the room
+- **Timer: Reset**  
+    Reset a specific timer to original duration
+- **Timer: Start**  
+    Start or resume a specific timer in the room
+- **Timer: Stop**  
+    Stop a specific timer in the room
+- **Timer: Toggle playback**  
+    Toggle (start/stop) a specific timer in the room
+- **Transport: Add time**  
+    Add an amount of time to the highlighted timer in the room.
+- **Transport: Next**  
+    Highlight the next timer in the list
+- **Transport: Previous**  
+    Reset the highlighted timer in the room if it is running. If the highlighted timer is not running, highlight the previous timer in the list. Optionally, you can automatically start the previous timer once it's highlighted.
+- **Transport: Start**  
+    Start or resume the highlighted timer in the room
+- **Transport: Start/stop**  
+    Start/stop the highlighted timer in the room
+- **Transport: Stop**  
+    Stop the highlighted timer in the room
+- **Transport: Subtract time**  
+    Subtract an amount of time from the highlighted timer in the room.
+- **Utility: Get room**  
+    Get status of the room
+- **Utility: Get status**  
+    Get playback status of the room
+- **Utility: Test auth**  
+    Test connection and authentication
+- **Viewer: Disable blackout mode**  
+    Disable blackout mode in the room
+- **Viewer: Disable focus mode**  
+    Disable focus mode in the room
+- **Viewer: Enable blackout mode**  
+    Enable blackout mode in the room
+- **Viewer: Enable focus mode**  
+    Enable focus mode in the room
+- **Viewer: Flash the screen**  
+    Flashes the screen in the room. Can be used to grab the attention of speakers.
+- **Viewer: Stop flashing**  
+    Stops any flashing timers and message on the screen.
+- **Viewer: Toggle blackout mode**  
+    Toggle (enable/disable) blackout mode in the room
+- **Viewer: Toggle focus mode**  
+    Toggle (enable/disable) focus mode in the room
+
+## Variables
+
+- `$(stagetimer:currentTimerDuration)` - Timer duration
+- `$(stagetimer:currentTimerDurationAsMs)` - Timer duration (ms)
+- `$(stagetimer:currentTimerId)` - Timer ID
+- `$(stagetimer:currentTimerName)` - Timer name
+- `$(stagetimer:currentTimerNotes)` - Timer notes
+- `$(stagetimer:currentTimerRemaining)` - Timer remaining time
+- `$(stagetimer:currentTimerRemainingAsMs)` - Timer remaining time (ms)
+- `$(stagetimer:currentTimerSpeaker)` - Timer speaker
+- `$(stagetimer:roomId)` - Room ID
+- `$(stagetimer:roomName)` - Room name
+
+## Feedbacks
+
+- Blackout mode
+- Flashing
+- Focus mode
+- Message showing
+- Playback running
+- Playback stopped
+- Timer is over time
+- Timer is running and on time
+- Timer is showing red wrap-up warning
+- Timer is showing yellow wrap-up warning

companion/manifest.json

@@ -0,0 +1,35 @@
+{
+	"id": "stagetimerio-api",
+	"name": "stagetimer",
+	"shortname": "stagetimer",
+	"description": "Stagetimer.io module for Companion v3",
+	"version": "2.0.0",
+	"license": "MIT",
+	"repository": "git+https://github.com/bitfocus/companion-module-stagetimerio-api.git",
+	"bugs": "https://github.com/bitfocus/companion-module-stagetimerio-api/issues",
+	"maintainers": [
+		{
+			"name": "Lukas Hermann",
+			"email": "[email protected]"
+		}
+	],
+	"runtime": {
+		"type": "node18",
+		"api": "nodejs-ipc",
+		"apiVersion": "0.0.0",
+		"entrypoint": "../src/index.js"
+	},
+	"legacyIds": [
+		"hermann-stagetimerio"
+	],
+	"manufacturer": "stagetimer.io",
+	"products": [
+		"Stagetimer API"
+	],
+	"keywords": [
+		"Stagetimer",
+		"stagetimer.io",
+		"Timer",
+		"Companion"
+	]
+}

jsconfig.json

@@ -0,0 +1,9 @@
+{
+	"compilerOptions": {
+		"checkJs": true,
+	},
+	"exclude": [
+		"node_modules",
+		"**/node_modules/*"
+	]
+}