Have ideas to improve npm?Join in the discussion! »

homebridge-rcswitch4

1.4.3 • Public • Published

homebridge-rcswitch4

NPM version

Control RF outlets with HomeKit / Siri using rcswitch4

Installation

  1. Install WiringPi
  2. Install homebridge: npm install -g homebridge
  3. Install homebridge-rcswitch-gpiomem: npm install --global homebridge-rcswitch4
  4. Update your configuration file.

Configuration

See sample-config.json

Either onCode and offCode or systemcode and unitcode are required. My switches use on and off codes, so that's what I recommend and all I can really help with.

  • accessory: Must be RCSwitch (case sensitive)
  • name :: string :: What you want to call the switch. Keep in mind that Siri will prefer anything other than your homebridge switch if there's any confusion, so name it something unique
  • onCode, offCode :: int or string
    • If int: Decimal RF code to turn switch on / off
    • If string: Binary RF code to turn switch on / off
  • systemcode :: string :: RF system code. I don't use this, please refer to other docs.
  • unitcode :: int :: RF unit code. I don't use this, please refer to other docs.
  • pin :: int, optional :: BCM pin connected to 433 mhz transmitter, defaults to 17
  • pulseLength :: int, optional :: RF pulse length, defaults to 190
  • bitLength :: int, optional :: bit length of RF code, only used if using decimal RF code, defaults to 24
  • repeats :: int, optional :: Number of times to repeat the transmission of the code, defaults to 10 (as per the original rcswitch code)

FAQ / Troubleshooting

It seems that the gpiomem system I use and the SysFS method of interacting with the GPIO are not compatible for reasons explained in this issue. Make sure that you aren't also using programs that access the GPIO by way of SysFS or this library may not work.

Changelog

20200106 :: 1.4.0

  • Moved to new rcswitch dependancy rcswitch4. Now supporting node v12.x.x
  • Added support for Hoobs configuration.

20180127 :: 1.3.0

  • Moved to new rcswitch dependancy rcswitch-gpiomem3. Now supporting node v10.x.x

20171003 :: 1.1.5

  • Moved enableTransmit into loop to allow different accessories to use different pins (@foodbag)

20160727 :: 1.1.3

  • Move setRepeatTransmit to just before calling switchOn() to facilitate multiple switches with different desired repeat counts

20160727 :: 1.1.2

  • Move setPulseLength from initialization to just before calling switchOn() to facilitate multiple switches with different pulse lengths (closes #2).

Install

npm i homebridge-rcswitch4

DownloadsWeekly Downloads

11

Version

1.4.3

License

MIT

Unpacked Size

211 kB

Total Files

8

Last publish

Collaborators

  • avatar