Skip to content

Commit ebb819b

Browse files
author
kamwa watanabe bjay
committed
change README
1 parent aa41e22 commit ebb819b

1 file changed

Lines changed: 9 additions & 31 deletions

File tree

README.md

Lines changed: 9 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
version 0.2.0
12
# Snips Skill Roku
23

34
[![Latest Version](https://img.shields.io/pypi/v/snipsroku.svg)](https://pypi.python.org/pypi/snipsroku/)
@@ -9,46 +10,23 @@ Note: Roku Search is only available in English, and only available for registere
910

1011
## Snips Manager
1112

12-
It is recommended that you use this skill with the [Snips Manager](https://github.com/snipsco/snipsmanager). Simply add the following section to your [Snipsfile](https://github.com/snipsco/snipsmanager/wiki/The-Snipsfile):
13-
14-
~~~yaml
15-
skills:
16-
- pip: https://github.com/snipsco/snips-skills-roku
17-
package_name: snipsroku
18-
params:
19-
roku_device_ip: <ROKU_DEVICE_IP>
20-
~~~
13+
It is recommended that you use this skill with the [snips skill server]().
2114

2215
## Usage
2316

2417
The skill allows you to control [Roku](https://www.roku.com/) TV. You can use it as follows:
18+
- Go to home screen
19+
- Get dict with installed apps and apps id
20+
- Launch a specifc app already installed
21+
- Search for content
22+
- Launch a specific series or movie. For instance, Black Mirror season 4
2523

26-
~~~python
27-
from snipsroku.snipsroku import SnipsRoku
28-
29-
30-
roku = SnipsRoku(<ROKU_DEVICE_IP>)
31-
# Go to home screen
32-
roku.home_screen()
33-
34-
# Get dict with installed apps and apps id
35-
roku.get_apps()
36-
37-
# Launch a specifc app already installed
38-
id = roku.get_app_id("Youtube")
39-
roku.launch_app(id)
40-
41-
# Search for content
42-
roku.search_content("tv-show", "Friends")
43-
44-
# Launch a specific series or movie. For instance, Black Mirror season 4
45-
roku.search_content("tv-show", "Black Mirror", None, True, "Netflix", 4)
46-
~~~
47-
24+
### Configuration
4825

4926
The `ROKU_DEVICE_IP` is used to identify your Roku device in the network. You can either obtain the IP through the Roku interface
5027
if you navigate to **Settings > Network > About** and note down what is next to "IP address". Alternatively, please follow the instructions
5128
[here](https://sdkdocs.roku.com/display/sdkdoc/External+Control+API#ExternalControlAPI-SSDP(SimpleServiceDiscoveryProtocol)).
29+
If this configuration is not set, the app will search your network for a Roku devices.
5230

5331
## Contributing
5432

0 commit comments

Comments
 (0)