Skip to content

Commit

Permalink
Updated README and default “Learn” accessory names
Browse files Browse the repository at this point in the history
  • Loading branch information
lprhodes committed Apr 28, 2017
1 parent 69753ca commit 99f41c7
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,9 @@ As of version 1.0.0 your Broadlink RM Device is automatically discovered so you

## Learning Hex IR and RF codes

A "Learn Code" accessory will automatically be added to the Home app and is dedicated to learning IR codes. Simply toggle the switch on, perform the IR command in front of your Broadlink RM device and copy the HEX output from the homebridge console log to wherever you want the code in the config.
"Learn" and "Scan Frequency" accessories are automatically added to the Home app (so long as you've not added either manually in the config). Simply toggle the switch on, perform the IR or RF command in front of your Broadlink RM device and copy the HEX output from the homebridge console log to wherever you want the code in the config.

The switch will toggle off automatically once the IR code has been received or 10 seconds has passed.

You can optionally stop attempting to learn a code by toggling the switch off yourself.
The switch will toggle off automatically once the code has been received. You can optionally stop attempting to learn a code by toggling the switch off yourself.

More details [below](#accessory-types)

Expand Down Expand Up @@ -60,6 +58,7 @@ You shouldn't need to add this accessory type yourself as we add one automatical
key | description | example | default
--- | ----------- | ------- | -------
disableAutomaticOff (optional) | Prevent the learn-code accessory from turning off automatically after a given amount of time or when a hex code has been received. | false | true
scanRF (optional) | This changes the type of learning to be the same as the default "Scan Frequency" | true | false

### switch

Expand Down
4 changes: 2 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ class BroadlinkRMPlatform {
const learnCodeAccessory = new Accessory.LearnCode(log, { name: 'Learn' });
accessories.push(learnCodeAccessory);

const sweepFrequencyAccessory = new Accessory.LearnCode(log, { name: 'Sweep Frequency', scanRF: true });
accessories.push(sweepFrequencyAccessory);
const scanFrequencyAccessory = new Accessory.LearnCode(log, { name: 'Scan Frequency', scanRF: true });
accessories.push(scanFrequencyAccessory);
}

// Check for no accessories
Expand Down

0 comments on commit 99f41c7

Please sign in to comment.