diff --git a/README.md b/README.md index 7fe5ea1..83093a0 100755 --- a/README.md +++ b/README.md @@ -1,105 +1,78 @@ -# rokuc - -### A cURL based roku remote for home automation - -This bash script leverages cURL and roku's External Control Protocol ([ECP](https://developer.roku.com/docs/developer-program/debugging/external-control-api.md)), to aid in home automation. - -## Usage : - -rokuc -a [ADDRESS] [ [-h] [-v] [-c [ARGS]] [-l [ARGS]] ] - -- -h                        Show help file - -- -v                        Enable verbos - -- -a [ADDRESS]    Ip address of roku device - -- -c [ARGS]            Commands to Roku control - - - play, pause, |, p    Pause and play - - - home, # Home menu - - - select, ok, . Select - - - vol+, v+, vup, + Volume up - - - vol-, v-, vdown, - Volume down - - - mute, m Mute - - - off, O Turn device off - - - on, I Turn device on - - - back, k Back - - - u, up Button Up - - - d, down Button Down - - - l, left Button Left - - - r, right Button Right - - - s.5 Sleep 0.5sec - - - s1 Sleep 1sec - - - s2 Sleep 2sec - - - s5 Sleep 5sec - -- -l [ARGS]             Launch Channel - - - plex - - - youtube - - - netflix - - - hulu - - - tv - - - hdmi1 - - - hdmi2 - - - hdmi3 - - - hdmi4 - - - av1 - -### Usage Examples - -Launch Netflix: - -```bash -$> ./rokuc -a 192.168.1.142 -l nexflix -``` - -Pause/Play: - -```bash -$> ./rokuc -a 192.168.1.142 -c pause -``` - -Multi command: Go home and turn volume down x2 - -```bash -$> ./rokuc -a 192.168.1.142 -c "# v- v-" -``` - -Launch plex, wait 5 seconds, move right, select: - -```bash -$> /rokuc -a 192.168.11.142 -l plex -c "s5 > ." -``` - - - -###### Roku ECP documentation: [LINK](https://developer.roku.com/docs/developer-program/debugging/external-control-api.md) - - +# rokuc + +### A cURL based roku remote for home automation + +This bash script leverages cURL and roku's External Control Protocol ([ECP](https://developer.roku.com/docs/developer-program/debugging/external-control-api.md)), to aid in home automation. + +## Usage : + +``` + -a | --address IP address of roku device ** REQUIRED ** + -c | --command Send remote commands to device + -l | --launch Launch Channel/Application on device + -v | --verbose Enable verbose mode + -h | --help Display this message + +Args for [-c|--command] flag + play | pause | | | p Pause and Play + home | # Go to home screen + select | ok | . Select + vol+ | v+ | vup | + Turn volume up + vol- | v- | vdown | - Turn volume down + mute | m Mute + off | power-off | shutdown | O Power off Roku TV + on | power-on | startup | I Power on Roku TV + back | k Back + u | up | ^ Up arrow + d | down | v Down arrow + l | left | < Left arrow + r | right | > Right arrow + s.5 Wait 0.5 seconds + s1 Wait 1 second + s2 Wait 2 seconds + s5 Wait 5 seconds + +Args for [-l|--launch] flag + plex Launch Plex.tv + youtube Launch YouTube + netflix Launch Netflix + hulu Launch Hulu + tv Launch Digital TV on Roku TVs + hdmi1 Launch HDMI1 + hdmi2 Launch HDMI2 + hdmi3 Launch HDMI3 + hdmi4 Launch HDMI4 + av1 Launch AV1 + +``` +### Usage Examples + +Launch Netflix: + +```bash +$> ./rokuc -a 192.168.1.142 -l nexflix +``` + +Pause/Play: + +```bash +$> ./rokuc -a 192.168.1.142 -c pause +``` + +Multi command: Go home and turn volume down x2 + +```bash +$> ./rokuc -a 192.168.1.142 -c "# v- v-" +``` + +Launch plex, wait 5 seconds, move right, select: + +```bash +$> /rokuc -a 192.168.11.142 -l plex -c "s5 > ." +``` + + + +###### Roku ECP documentation: [LINK](https://developer.roku.com/docs/developer-program/debugging/external-control-api.md) + +