diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 197 |
1 files changed, 85 insertions, 112 deletions
diff --git a/README.md b/README.md index 8faba2be75fc..82daa7a74645 100644 --- a/README.md +++ b/README.md @@ -1,112 +1,85 @@ -Python control for Broadlink RM2, RM3 and RM4 series controllers -=============================================== - -A simple Python API for controlling IR/RF controllers from [Broadlink](http://www.ibroadlink.com/rm/). At present, the following devices are currently supported: - -* RM Pro (referred to as RM2 in the codebase) -* A1 sensor platform devices are supported -* RM3 mini IR blaster -* RM4 and RM4C mini blasters - -There is currently no support for the cloud API. - -Example use ------------ - -Setup a new device on your local wireless network: - -1. Put the device into AP Mode - 1. Long press the reset button until the blue LED is blinking quickly. - 2. Long press again until blue LED is blinking slowly. - 3. Manually connect to the WiFi SSID named BroadlinkProv. -2. Run setup() and provide your ssid, network password (if secured), and set the security mode - 1. Security mode options are (0 = none, 1 = WEP, 2 = WPA1, 3 = WPA2, 4 = WPA1/2) -``` -import broadlink - -broadlink.setup('myssid', 'mynetworkpass', 3) -``` - -Discover available devices on the local network: -``` -import broadlink - -devices = broadlink.discover(timeout=5) -``` - -Obtain the authentication key required for further communication: -``` -devices[0].auth() -``` - -Enter learning mode: -``` -devices[0].enter_learning() -``` - -Sweep RF frequencies: -``` -devices[0].sweep_frequency() -``` - -Cancel sweep RF frequencies: -``` -devices[0].cancel_sweep_frequency() -``` -Check whether a frequency has been found: -``` -found = devices[0].check_frequency() -``` -(This will return True if the RM has locked onto a frequency, False otherwise) - -Attempt to learn an RF packet: -``` -found = devices[0].find_rf_packet() -``` -(This will return True if a packet has been found, False otherwise) - -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 or RF packet: -``` -devices[0].send_data(ir_packet) -``` - -Obtain temperature data from an RM2: -``` -devices[0].check_temperature() -``` - -Obtain sensor data from an A1: -``` -data = devices[0].check_sensors() -``` - -Set power state on a SmartPlug SP2/SP3: -``` -devices[0].set_power(True) -``` - -Check power state on a SmartPlug: -``` -state = devices[0].check_power() -``` - -Check energy consumption on a SmartPlug: -``` -state = devices[0].get_energy() -``` - -Set power state for S1 on a SmartPowerStrip MP1: -``` -devices[0].set_power(1, True) -``` - -Check power state on a SmartPowerStrip: -``` -state = devices[0].check_power() -``` +depot +===== + +[](https://builds.sr.ht/~tazjin/depot/master?) + +This repository is the [monorepo][] for my personal tools and infrastructure. +Everything in here is built using [Nix][] with an automatic attribute-set layout +that mirrors the filesystem layout of the repository (this might feel familiar +to users of Bazel). + +This repository used to be hosted on GitHub, but for a variety of reasons I have +decided to take over the management of personal infrastructure - of which this +repository is a core component. + +If you've ended up here and have no idea who I am, feel free to follow me [on +Twitter][]. + +# Highlights + +## Tools + +* `tools/emacs` contains my personal Emacs configuration (packages & config) +* `fun/aoc2019` contains solutions for a handful of Advent of Code 2019 + challenges, before I ran out of interest +* `tools/blog_cli` contains my tool for writing new blog posts and storing them + in the DNS zone +* `tools/cheddar` contains a source code and Markdown rendering tool + that is integrated with my cgit instance to render files in various + views +* `ops/kms_pass.nix` is a tiny tool that emulates the user-interface of `pass`, + but actually uses Google Cloud KMS for secret decryption +* `ops/kontemplate` contains my Kubernetes resource templating tool (with which + the services in this repository are deployed!) +* `ops/besadii` contains a tool that runs as the git + `post-receive`-hook on my git server to trigger builds on sourcehut. + +## Packages / Libraries + +* `nix/buildGo` implements a Nix library that can build Go software in the style + of Bazel's `rules_go`. Go programs in this repository are built using this + library. +* `nix/buildLisp` implements a Nix library that can build Common Lisp + software. Currently only SBCL is supported. Lisp programs in this + repository are built using this library. +* `tools/emacs-pkgs` contains various Emacs libraries that my Emacs setup uses, + for example: + * `dottime.el` provides [dottime][] in the Emacs modeline + * `nix-util.el` provides editing utilities for Nix files + * `term-switcher.el` is an ivy-function for switching between vterm buffers +* `net/alcoholic_jwt` contains an easy-to-use JWT-validation library for Rust +* `net/crimp` contains a high-level HTTP client using cURL for Rust + +## Services + +Services in this repository are deployed on a Google Kubernetes Engine cluster +using [Nixery](). + +* `web/blog` and `web/homepage` contain my blog and website setup + (serving at [tazj.in][]) +* `web/cgit-taz` contains a slightly patched version of `cgit` that serves my + git web interface at [git.tazj.in][] +* `ops/journaldriver` contains a small Rust daemon that can forward logs from + journald to Stackdriver Logging + +## Miscellaneous + +Presentations I've given in the past are in the `presentations` folder, these +cover a variety of topics and some of them have links to recordings. + +There's a few fun things in the `fun/` folder, often with context given in the +README. Check out my [list of the best tools][best-tools] for example. + +# Contributing + +If you'd like to contribute to any of the tools in here, please check out the +[contribution guidelines](/tree/docs/CONTRIBUTING.md). + +[monorepo]: https://en.wikipedia.org/wiki/Monorepo +[Nix]: https://nixos.org/nix +[on Twitter]: https://twitter.com/tazjin +[Nixery]: https://github.com/google/nixery +[tazj.in]: https://tazj.in +[git.tazj.in]: https://git.tazj.in +[best-tools]: /about/fun/best-tools/README.md +[dottime]: https://dotti.me |