Trigger origin (#25)

* Adding trigger property to output

* Bump version

---------

Co-authored-by: Thomas Bowman Mørch <thomas.git@bowmo.dk>

Author: tbowmo

README.md

@@ -73,6 +73,7 @@ The rules is read and executed one by one, it is the outcome after the last rule
 By default the node has a single output, which provides the following object: 
 ```ts
 {
+    trigger: 'input' | 'timer',
     autoState: boolean,
     timeout: number,
     temporaryManual: boolean,
@@ -87,6 +88,7 @@ By default the node has a single output, which provides the following object:
 
 | property | description |
 |----------|-------------|
+| trigger  | if the output is triggered by an input message, then this property is set to "input" otherwise it is set to "timer"|
 | autoState|will be true whenever the node is running in auto mode
 |timeout | indicates how long there is until the node will return to auto state, when in temporary override|
 |temporaryManual| Will be true when the node is in temporary override|

package.json

@@ -3,7 +3,7 @@
     "author": {
         "name": "Thomas Bowman Mørch"
     },
-    "version": "0.9.1",
+    "version": "0.10.0",
     "engines": {
         "node": ">=14.0.0"
     },

src/lib/interfaces.ts

@@ -1,5 +1,8 @@
 import { NodeMessage, NodeMessageInFlow } from 'node-red'
 
+export type State = 'auto' | 'tempOn' | 'tempOff'
+export type Trigger = 'input' | 'timer'
+
 export interface ISmallTimerMessage extends NodeMessageInFlow {
     reset?: boolean,
     timeout?: number,
@@ -11,5 +14,6 @@ export type SmallTimerChangeMessage = NodeMessage & {
     temporaryManual: boolean,
     duration: number,
     stamp: number,
-    state: string
+    state: State,
+    trigger: Trigger
 }

src/lib/small-timer-runner.spec.ts

@@ -172,6 +172,7 @@ describe('lib/small-timer-runner', () => {
             timeout: 0,
             payload: '0',
             topic: 'test-topic',
+            trigger: 'timer',
         })
         stubs.stubbedTimeCalc.getOnState.returns(true)
         sinon.clock.tick(60000)
@@ -189,6 +190,7 @@ describe('lib/small-timer-runner', () => {
             timeout: 0,
             payload: 'on-msg',
             topic: 'test-topic',
+            trigger: 'timer',
         })
     })
 
@@ -219,6 +221,7 @@ describe('lib/small-timer-runner', () => {
                 timeout: 0,
                 payload: 'off',
                 topic: 'test-topic',
+                trigger: 'timer',
             },
             { debug: 'this is debug', override: 'auto', topic: 'debug' },
         ])
@@ -250,6 +253,7 @@ describe('lib/small-timer-runner', () => {
             timeout: 0,
             payload: '0',
             topic: 'test-topic',
+            trigger: 'timer',
         })
         stubs.stubbedTimeCalc.getOnState.returns(true)
         sinon.clock.tick(1200000)
@@ -285,6 +289,7 @@ describe('lib/small-timer-runner', () => {
                 timeout: 0,
                 payload: '0',
                 topic: 'test-topic',
+                trigger: 'timer',
             })
 
             runner.onMessage({ payload: 'toggle', _msgid: 'some-msg' })
@@ -303,6 +308,7 @@ describe('lib/small-timer-runner', () => {
                 timeout: 0,
                 payload: 'on-msg',
                 topic: 'test-topic',
+                trigger: 'input',
             })
 
             runner.onMessage({ payload: 'toggle', _msgid: 'some-msg' })
@@ -320,6 +326,7 @@ describe('lib/small-timer-runner', () => {
                 timeout: 0,
                 payload: '0',
                 topic: 'test-topic',
+                trigger: 'input',
             })
         })
 
@@ -348,6 +355,7 @@ describe('lib/small-timer-runner', () => {
                 timeout: 0,
                 payload: '0',
                 topic: 'test-topic',
+                trigger: 'timer',
             })
 
             runner.onMessage({ payload: 'sync', _msgid: 'some-id' })
@@ -365,6 +373,7 @@ describe('lib/small-timer-runner', () => {
                 timeout: 0,
                 payload: '0',
                 topic: 'test-topic',
+                trigger: 'input',
             }])
         })
 
@@ -393,6 +402,7 @@ describe('lib/small-timer-runner', () => {
                 timeout: 0,
                 payload: '0',
                 topic: 'test-topic',
+                trigger: 'timer',
             })
 
             runner.onMessage({ payload: 'toggle', timeout: 10, _msgid: 'some-msg' })

src/lib/small-timer-runner.ts

@@ -7,12 +7,15 @@ import {
 } from 'node-red'
 import { util } from '@node-red/util'
 import { ISmallTimerProperties, Rule } from '../nodes/common'
-import { SmallTimerChangeMessage, ISmallTimerMessage } from './interfaces'
+import {
+    SmallTimerChangeMessage,
+    ISmallTimerMessage,
+    Trigger,
+    State,
+} from './interfaces'
 import { TimeCalc } from './time-calculation'
 import { Timer } from './timer'
 
-type Override = 'auto' | 'tempOn' | 'tempOff'
-
 type NodeFunctions = Node
 
 type Position = {
@@ -29,7 +32,7 @@ export class SmallTimerRunner {
     // Timing variables
     private tickTimer: ReturnType<typeof setInterval> | undefined = undefined
 
-    private override: Override = 'auto'
+    private override: State = 'auto'
     private currentState = false
 
     private topic: string
@@ -102,7 +105,7 @@ export class SmallTimerRunner {
         } as NodeMessage // we cheat a bit to escape type checking in typescript
     }
 
-    private generateMsg(): SmallTimerChangeMessage {
+    private generateMsg(trigger: Trigger): SmallTimerChangeMessage {
         const on = this.getCurrentState()
 
         const payload = on
@@ -118,14 +121,15 @@ export class SmallTimerRunner {
             timeout: this.timer.timeLeft(),
             payload: payload,
             topic: this.topic,
+            trigger,
         }
     }
 
-    private publishState(): void {
+    private publishState(trigger: Trigger): void {
         if (this.debugMode) {
-            this.node.send([this.generateMsg(), this.generateDebug()])
+            this.node.send([this.generateMsg(trigger), this.generateDebug()])
         } else {
-            this.node.send(this.generateMsg())
+            this.node.send(this.generateMsg(trigger))
         }
     }
 
@@ -177,14 +181,14 @@ export class SmallTimerRunner {
         this.updateNodeStatus()
 
         if (change || this.repeat) {
-            this.publishState()
+            this.publishState('timer')
         }
     }
 
-    private forceSend(): void {
+    private forceSend(trigger: Trigger = 'timer'): void {
         this.calcState()
         this.updateNodeStatus()
-        this.publishState()
+        this.publishState(trigger)
     }
 
     /**
@@ -269,7 +273,7 @@ export class SmallTimerRunner {
         this.node.status(status)
     }
 
-    private doOverride(override: Override, timeout?: number): void {
+    private doOverride(override: State, timeout?: number): void {
         this.override = override
         if (override === 'auto') {
             this.timer.stop()
@@ -309,7 +313,7 @@ export class SmallTimerRunner {
         // eslint-disable-next-line no-extra-boolean-cast
         if (incomingMsg.reset !== undefined) {
             this.doOverride('auto')
-            this.forceSend()
+            this.forceSend('input')
             return 
         }
 
@@ -348,7 +352,7 @@ export class SmallTimerRunner {
         default:
             throw new Error(`Did not understand the command '${incomingMsg.payload}' supplied in payload`)
         }
-        this.forceSend()
+        this.forceSend('input')
     }
 
     /**