You are currently viewing the Homey Apps SDK v2 documentation. New apps should use Homey Apps SDK v3 ››

Homey.Signal 

const { Signal } = require('homey');

The Signal class represents an Signal as defined in the app's app.json.

Table of Contents

Constructor

new Homey.Signal(id, frequency)

Library:
Parameters:
Name Type Description
id string

The ID of the signal, as defined in the app's app.json.
frequency string

The frequency of the signal

Methods

cmd(commandId, optsopt, callbackopt) → {Promise}

Transmit a command

Parameters:
Name Type Attributes Description
commandId string

The ID of the command, as specified in /app.json
opts object <optional>

Transmission options

Name Type Attributes Description
repetitions object <optional>

A custom amount of repetitions
callback genericCallbackFunction <optional>
Returns:
Type:
Promise

register(callbackopt) → {Promise}

Register the signal. This is a shorthand method for ManagerRF#registerSignal.

Parameters:
Name Type Attributes Description
callback genericCallbackFunction <optional>
Returns:
Type:
Promise

tx(frame, optsopt, callbackopt) → {Promise}

Transmit a frame

Parameters:
Name Type Attributes Description
frame Array

An array of word indexes
opts object <optional>

Transmission options

Name Type Attributes Description
repetitions object <optional>

A custom amount of repetitions
callback genericCallbackFunction <optional>
Returns:
Type:
Promise

unregister(callbackopt) → {Promise}

Unregister the signal. This is a shorthand method for ManagerRF#unregisterSignal.

Parameters:
Name Type Attributes Description
callback genericCallbackFunction <optional>
Returns:
Type:
Promise