diff options
| author | Ivan F. Martinez <ivanfmartinez@users.noreply.github.com> | 2017-01-11T00·57-0200 |
|---|---|---|
| committer | Matthew Garrett <mjg59-github@srcf.ucam.org> | 2017-04-22T19·42-0700 |
| commit | de7c5c2a2af68b88aff982d7a1fec5b3dcfd7d3b (patch) | |
| tree | 57bf2f833eebe26d02ce3613f80e458bff03912c | |
| parent | 76dd4cfc70fa95ae703c680998757be180deed36 (diff) | |
basic documentation for cli programs
| -rw-r--r-- | cli/README.md | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/cli/README.md b/cli/README.md new file mode 100644 index 000000000000..47b45f4c97d3 --- /dev/null +++ b/cli/README.md @@ -0,0 +1,75 @@ +Command line interface for python-broadlink +=========================================== + +This is a command line interface for broadlink python library + +Tested with BroadLink RMPRO / RM2 + + +Requirements +------------ +You should have the broadlink python installed, this can be made in many linux distributions using : +``` +sudo pip install broadlink +``` + +Instalation +----------- +Just copy this files + + +Programs +-------- + + +* broadlink_discovery +used to run the discovery in the network +this program withh show the command line parameters to be used with +broadlink_cli to select broadlink device + +* broadlink_cli +used to send commands and query the broadlink device + + +device specification formats +---------------------------- + +Using separate parameters for each information: +``` +broadlink_cli --type 0x2712 --host 1.1.1.1 --mac aaaaaaaaaa --temp +``` + +Using all parameters as a single argument: +``` +broadlink_cli --device "0x2712 1.1.1.1 aaaaaaaaaa" --temp +``` + +Using file with parameters: +``` +broadlink_cli --device @BEDROOM.device --temp +``` +This is prefered as the configuration is stored in file and you can change +just a file to point to a different hardware + +Sample usage +------------ + +Learn commands : +``` +# Learn and save to file +broadlink_cli --device @BEDROOM.device --learnfile LG-TV.power +# LEard and show at console +broadlink_cli --device @BEDROOM.device --learn +``` + + +Send command : +``` +broadlink_cli --device @BEDROOM.device --send @LG-TV.power +broadlink_cli --device @BEDROOM.device --send ....datafromlearncommand... +``` + +Get Temperature : +``` +broadlink_cli --device @BEDROOM.device --temperature +``` |