Skip to content

Commit

Permalink
Merge pull request #354 from Andrek01/develop
Browse files Browse the repository at this point in the history
AlexaRc4shNG: Update requirements and corrected some typos
  • Loading branch information
msinn authored Apr 13, 2020
2 parents ae51359 + a44d177 commit ea689ce
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 11 deletions.
9 changes: 5 additions & 4 deletions alexarc4shng/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
The plugin gives the possibilty to control an Alexa-Echo-Device remote by smartHomeNG. So its possible to switch on an TuneIn-Radio Channel, send some messages via Text2Speech when an event happens on the knx-bus or on the Visu. On the Web-Interface you can define your own commandlets (functions). The follwing functions are available on the Web-Interface :

- Store a cookie-file to get access to the Alexa-WebInterface
- manually Login with your credentials (sored in the /etc/plugin.yaml)
- manually Login with your credentials (stored in the /etc/plugin.yaml)
- See all available devices, select one to send Test-Functions
- define Commandlets - you can load,store,delete, check and test Commandlets
- the Commandlets can be loaded to the webinterface by clicking on the list
Expand All @@ -28,7 +28,7 @@ Special thanks to Jonofe from the [Edomi-Forum](https://knx-user-forum.de/forum/
5. [Configuration](#config)
6. [functions](#functions)
7. [Web-Interface](#webinterface)
8. [How to implmentend new Commands](#newCommand)
8. [How to implement new Commands](#newCommand)
9. [Tips for existing Command-Lets](#tipps)

### Existing Command-Lets
Expand Down Expand Up @@ -59,10 +59,10 @@ Special thanks to Jonofe from the [Edomi-Forum](https://knx-user-forum.de/forum/

#### 2020.03.20 Version 1.0.2

- <strong>changed public function "send_cmd_by_curl" to "send_cmd"</strong>
- removed pycurl
- changed Communication to Python Requests
- added translation for the Web-Interface
- changed public function "send_cmd_by_curl" to "send_cmd"
- added public function "get_last_alexa"

#### 2018.07.26 Version 1.0.1
Expand All @@ -75,7 +75,7 @@ Special thanks to Jonofe from the [Edomi-Forum](https://knx-user-forum.de/forum/
- changed version to 1.0.1
- changed to lib.item and lib.scheduler
- the credentials have to be stored in base64 encoded
- Login / LogOff Button to the Web-Interface
- added Login / LogOff Button to the Web-Interface
- added Auto-Login function - when there is no cookie-file with correct values and credentials are specicified, the plugin automaticaly logs in
- the log-in (the cookie) will be refreshed after the login_update_cycle
- changed methods-names and parameters to lower case and underscore separated names
Expand All @@ -102,6 +102,7 @@ Special thanks to Jonofe from the [Edomi-Forum](https://knx-user-forum.de/forum/
### Needed software

* smarthomeNg 1.5.2 and above for the web-interface
* needs Python requests
* a valid [Cookie](#cookie) from an alexa.amazon-Web-Site Session
* if you work with Autologin the credentials have to be entered "base64"-encoded. You can encode you credentials on the web-interface of the plugin <strong>"[email protected]:your_pwd"</strong> you will get <strong>```dXNlci50ZXN0QGdtYWlsLmNvbTp5b3VyX3B3ZA==``` </strong>.
So please enter <strong>```dXNlci50ZXN0QGdtYWlsLmNvbTp5b3VyX3B3ZA==```</strong> in the /etc/plugin.yaml
Expand Down
2 changes: 1 addition & 1 deletion alexarc4shng/plugin.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ plugin:
en: 'Plugin to remote control Echo Show/Spot/Fire'
maintainer: AndreK
tester: henfri, juergen, psilo
documentation: https://github.com/Andrek01 # url of documentation (wiki) page
documentation: https://www.smarthomeng.de/user/plugins/alexarc4shng/user_doc.html # url of documentation
version: 1.0.2 # Plugin version
sh_minversion: 1.5.2 # minimum shNG version to use this plugin
multi_instance: False # plugin supports multi instance
Expand Down
2 changes: 1 addition & 1 deletion alexarc4shng/requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
pycurl>=7.43.0;python_version>'3.2'
#requests requirement moved to core
10 changes: 5 additions & 5 deletions alexarc4shng/user_doc.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. index:: Plugins; Remote Control for Alexa devices
.. index:: AlexaRc4shNG
.. index:: alexarc4shng

alexarc4shng
AlexaRc4shNG
###

Konfiguration
Expand All @@ -18,7 +18,7 @@ Es können neue Kommandos erstellt werden

.. important::

Das Webinterface des Plugins kann mit SmartHomeNG v1.4.2 und davor **nicht** genutzt werden.
Das Webinterface des Plugins kann mit SmartHomeNG v1.5.2 und davor **nicht** genutzt werden.
Es wird dann nicht geladen. Diese Einschränkung gilt nur für das Webinterface. Ansonsten gilt
für das Plugin die in den Metadaten angegebene minimale SmartHomeNG Version.

Expand All @@ -44,12 +44,12 @@ Im ersten Tab kann das Cookie File gespeichert werden - in die Textarea via Cut
.. image:: assets/webif1.jpg
:class: screenshot

Im zweiten Tab werden die verfügbaren Geräte angezeigt - Durch click auf eine Gerät wird dieses selektiert und steht für Tests zur Verfügung:
Im zweiten Tab werden die verfügbaren Geräte angezeigt - Durch click auf ein Gerät wird dieses selektiert und steht für Tests zur Verfügung:

.. image:: assets/webif2.jpg
:class: screenshot

Im dritten Tab werden die Commandlets verwaltet - mit Clickauf die Liste der Commandlets wird dieses ins WebIF geladen:
Im dritten Tab werden die Commandlets verwaltet - mit Click auf die Liste der Commandlets wird dieses ins WebIF geladen:

.. image:: assets/webif3.jpg
:class: screenshot
Expand Down

0 comments on commit ea689ce

Please sign in to comment.