Skip to content

Commit

Permalink
Update documentation to cover RF packets
Browse files Browse the repository at this point in the history
RF packets behave identically to IR packets, so update the docs to match
  • Loading branch information
Matthew Garrett committed Oct 30, 2016
1 parent 989009e commit 9257427
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ Enter learning mode:
devices[0].enter_learning()
```

Obtain an IR packet while in learning mode:
Obtain an IR or RF packet while in learning mode:
```
ir_packet = devices[0].check_data()
```
(This will return None if the device does not have a packet to return)

Send an IR packet:
Send an IR or RF packet:
```
devices[0].send_data(ir_packet)
```
Expand Down
1 change: 0 additions & 1 deletion protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,5 +132,4 @@ Todo
----

* Support for other devices using the Broadlink protocol (various smart home devices)
* Verify whether RF learning uses the same information. The first 4 bytes of the response packet may indicate the type of response that was learned, and the first 4 bytes of the payload may provide that back to the Broadlink on sending. Alternatively, this information may be embedded in the response data already.
* Figure out what the format of the data packets actually is.

0 comments on commit 9257427

Please sign in to comment.