Raum0x2A/rokuc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Bradley Richins
2020-05-17 01:39:48 +00:00
parent cef6d62872
commit cf2ae0d5bf
1 changed files with 78 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

183
README.md
View File

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