# mytimeout

> A timer that support setting the run time by passing JSON to the input

Latest version **1.0.2** (published 2017-11-02) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install mytimeout
pnpm add mytimeout
yarn add mytimeout
bun add mytimeout
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2017-11-02 |
| First published | 2017-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Neil Cherry |
| Maintainers | linuxha |
| Keywords | timer, mytimeout, cherry |

## Links

- npm: https://www.npmjs.com/package/mytimeout
- Repository: https://github.com/linuxha/node-red-contrib-mytimeout
- Homepage: https://github.com/linuxha/node-red-contrib-mytimeout#readme
- Issues: https://github.com/linuxha/node-red-contrib-mytimeout/issues
- npm.io page: https://npm.io/package/mytimeout

## Recent versions

- 1.0.2 (latest) — 2017-11-02
- 1.0.1 — 2017-11-01

## README

# node-red-contrib-mytimeout Readme
This is a fork of Peter Scargill's node-red-contrib-timeout module for node-red. I have different ideas of what a timer should do and how it should operate so I've taken to butchering Pete's code until it does what I want.

## myTimeout
Pete's code would start a timer running if you sent it any trigger (tickle the timer). It would contiunue to run if further triggers were sent before the timeout occurred. A trigger was anything sent to the input of the timer.

My code goes a step further, allowing you to send JSON (see below) to overrride the timer, to turn off the timer or to cancel or stop the timer. It still retains Pete's behaviors. You can still send almost anything to tickle the timer with the exception of the JSON below which will cause the timer to do specific things.

You can configure the timeout module with the settings for the Safe and Unsafe messages. Safe is sent on the start of the timer, the unsafe message sent when the timeout occurs.

* Name
* Output topic
* On state payload
* Warning state payload
* Off state payload
* Warning (sec)
* Countdown (sec)

* [ ] Repeat message every second
* [ ] Auto-restart when timed out
* [ ] Run at start

All of this is very useful for things like lights that are motion activated. If motion is detected, the Safe payload is sent (On or 1). The timer can be started when motion is detected and as long as the motion continues there will be no timeout. When the timeout occurs the Unsafe payload is sent (Off or 0). When the timeout warning time (n seconds before the timeout).

## MyTimeout
My additions to the code allows the user to send JSON in the triggers. You can override the timeout and warning times. 

```
{
    "payload": "on",
    "timeout": 3600,
    "warning": 300
}

{
    "payload": "off"
}

{
    "payload": "stop"
}

{
    "payload": "cancel"
}
```
### Payload
* *on* - turns on the timer. Requires the addition fields *timeout* and *warning*. Both field values are integers and are in seconds. This payload will cause the timer to send a *Timer on payload* message in the msg.payload output
* *off* - turns off the timer. This payload will cause the timer to send a *Timer off payload* in the msg.payload output
* *stop* - stops the timer. This payload will cause the timer to send *stop* in the msg.payload output
* *cancel* - cancels the timer. This payload will cause the timer to cancel but send nothing in the msg.payload output

When sending the JSON *on* message, payload, timeout and warning are
all required. The JSON message *off* will immediately cause a timeout
sending an *Timer off payload* as the message. The JSON *stop* message
will stop the timeout and send the stop as the message. The JSON
*cancel* (or *cancel*) message will stop the timeout and not send a
message. There is very little difference in the *off*, *stop* and
*cancel* behaviors other than what is sent or not sent to the
topic. They all stop the timer.

# Timeout (original Readme)

A simple timeout by Peter Scargill (pete@scargill.org). After setting
the topic and both safe and unsafe messages, for, for example MQTT (or
simply puttting 1 and 0 into the two messages) the node is triggered
by any input and will send the SAFE message out. If continually
triggered nothing more will happen but if allowed to timeout, the
UNSAFE message will be sent. Hence this can be used as a watchdog.

For more IOT, visit https://tech.scargill.net

---
_Source: https://npm.io/package/mytimeout · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._