Skip to content

Commit

Permalink
Deploying to gh-pages from @ smarthomeNG/plugins@9c96f16 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
msinn committed Jan 16, 2024
1 parent 111a14a commit 65d0ffb
Show file tree
Hide file tree
Showing 9 changed files with 47 additions and 8,018 deletions.
Binary file removed _images/Alexa_lists.jpg
Binary file not shown.
1,275 changes: 0 additions & 1,275 deletions _sources/plugins/alexa4p3/README.not_convertable.md.txt

This file was deleted.

32 changes: 16 additions & 16 deletions _sources/plugins/alexarc4shng/README.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ Special thanks to Jonofe from the [Edomi-Forum](https://knx-user-forum.de/forum/

## table of content

1. [PlaceHolders](#placeholders)
2. [Change Log](#changelog)
3. [Requirements](#requirements)
4. [Cookie](#cookie)
5. [Configuration](#config)
6. [functions](#functions)
7. [Web-Interface](#webinterface)
8. [How to implement new Commands](#newCommand)
9. [Tips for existing Command-Lets](#tipps)
1. PlaceHolders
2. Change Log
3. Requirements
4. Cookie
5. Configuration
6. functions
7. Web-Interface
8. How to implement new Commands
9. Tips for existing Command-Lets

### Existing Command-Lets

Expand All @@ -38,7 +38,7 @@ Special thanks to Jonofe from the [Edomi-Forum](https://knx-user-forum.de/forum/
- Pause (pauses the actual media)
- Text2Speech (sends a Text to the echo, echo will speak it)
- StartTuneInStation (starts a TuneInRadiostation with the guideID you send)
- SSML (Speak to Text with [Speech Synthesis Markup Language](https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html))
- SSML (Speak to Text with Speech Synthesis Markup Language)
- VolumeAdj (adjusts the volume during playing some media not working from webinterface test functions)
- VolumeSet (sets the volume to value from 0-100 percent)

Expand Down Expand Up @@ -111,7 +111,7 @@ Special thanks to Jonofe from the [Edomi-Forum](https://knx-user-forum.de/forum/

* smarthomeNg 1.5.2 and above for the web-interface
* needs Python requests
* a valid [Cookie](#cookie) from an alexa.amazon-Web-Site Session
* a valid 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>"user.test@gmail.com:your_pwd"</strong> you will get <strong>```dXNlci50ZXN0QGdtYWlsLmNvbTp5b3VyX3B3ZA==``` </strong>.
So please enter <strong>```dXNlci50ZXN0QGdtYWlsLmNvbTp5b3VyX3B3ZA==```</strong> in the /etc/plugin.yaml

Expand Down Expand Up @@ -306,7 +306,7 @@ sh.AlexaRc4shNG.send_cmd('Kueche','Text2Speech','Der Sensor der Hebenlage signal
```
Sends a command to the device. "dvName" is the name of the device, "cmdName" is the name of the CommandLet, mValue is the value you would send.
You can find all this informations on the Web-Interface.
You can also use the [placeholders](#placeholders)
You can also use the placeholders

- the result will be the HTTP-Status of the request as string (str)

Expand Down Expand Up @@ -371,7 +371,7 @@ status.activelist('','Alexa_Lists.list.shopping','value','date','value','info')
</pre>

### Ergebnis :
![PlaceHolder](./assets/Alexa_lists.jpg "jpg")
!PlaceHolder



Expand All @@ -391,12 +391,12 @@ Now the available devices from your alexa-account will be discoverd an shown on

You can also login / logoff when credentials are available. Please see results in the textarea on the right. Please refresh page manually after successfull login via the Web-Interface.

![PlaceHolder](./assets/webif1.jpg "jpg")
!PlaceHolder

## Alexa devices

By click on one device the device will be selected as acutal device for tests.
![PlaceHolder](./assets/webif2.jpg "jpg")
!PlaceHolder

## Command-Handling

Expand All @@ -411,7 +411,7 @@ You can enter test values in the field for the values. Press Test and the comman

<strong>For test dont modify the payload, just use the test-value-field </strong>

![PlaceHolder](./assets/webif3.jpg "jpg")
!PlaceHolder
<br>

## How to create new Command-Lets (spy out the Amazon-Web-Interface)<a name="newCommand"/></a>
Expand Down
14 changes: 7 additions & 7 deletions _sources/plugins/mieleathome/README.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ aufgebaut.

## table of content

1. [Change Log](#changelog)
2. [Aktivierung des Zugriffs für 3rd party-Apps](#activate)
3. [Einstellungen in der plugin.yaml](#plugin_yaml)
4. [Ermittln der Device-ID´s](#device_id)
5. [Items definieren](#create_items)
6. [Darstellung in der VISU](#visu)
7. [known issues](#issues)
1. Change Log
2. Aktivierung des Zugriffs für 3rd party-Apps
3. Einstellungen in der plugin.yaml
4. Ermittln der Device-ID´s
5. Items definieren
6. Darstellung in der VISU
7. known issues

## ChangeLog<a name="changelog"/>

Expand Down
Binary file modified objects.inv
Binary file not shown.
6,696 changes: 0 additions & 6,696 deletions plugins/alexa4p3/README.not_convertable.html

This file was deleted.

32 changes: 16 additions & 16 deletions plugins/alexarc4shng/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -5501,15 +5501,15 @@ <h2>!! So many thanks for the very good research and development in the past !!<
<section id="table-of-content">
<h2>table of content<a class="headerlink" href="#table-of-content" title="Permalink to this heading"></a></h2>
<ol class="arabic simple">
<li><p><a class="reference internal" href="#placeholders"><span class="xref myst">PlaceHolders</span></a></p></li>
<li><p><a class="reference internal" href="#changelog"><span class="xref myst">Change Log</span></a></p></li>
<li><p><a class="reference internal" href="#requirements"><span class="xref myst">Requirements</span></a></p></li>
<li><p><a class="reference internal" href="#cookie"><span class="xref myst">Cookie</span></a></p></li>
<li><p><a class="reference internal" href="../../lib/config.html#module-lib.config" title="lib.config"><span class="xref myst py py-mod">Configuration</span></a></p></li>
<li><p><a class="reference internal" href="#functions"><span class="xref myst">functions</span></a></p></li>
<li><p><a class="reference internal" href="#webinterface"><span class="xref myst">Web-Interface</span></a></p></li>
<li><p><a class="reference internal" href="#newCommand"><span class="xref myst">How to implement new Commands</span></a></p></li>
<li><p><a class="reference internal" href="#tipps"><span class="xref myst">Tips for existing Command-Lets</span></a></p></li>
<li><p>PlaceHolders</p></li>
<li><p>Change Log</p></li>
<li><p>Requirements</p></li>
<li><p>Cookie</p></li>
<li><p>Configuration</p></li>
<li><p>functions</p></li>
<li><p>Web-Interface</p></li>
<li><p>How to implement new Commands</p></li>
<li><p>Tips for existing Command-Lets</p></li>
</ol>
<section id="existing-command-lets">
<h3>Existing Command-Lets<a class="headerlink" href="#existing-command-lets" title="Permalink to this heading"></a></h3>
Expand All @@ -5518,7 +5518,7 @@ <h3>Existing Command-Lets<a class="headerlink" href="#existing-command-lets" tit
<li><p>Pause (pauses the actual media)</p></li>
<li><p>Text2Speech (sends a Text to the echo, echo will speak it)</p></li>
<li><p>StartTuneInStation (starts a TuneInRadiostation with the guideID you send)</p></li>
<li><p>SSML (Speak to Text with <a class="reference external" href="https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html">Speech Synthesis Markup Language</a>)</p></li>
<li><p>SSML (Speak to Text with Speech Synthesis Markup Language)</p></li>
<li><p>VolumeAdj (adjusts the volume during playing some media not working from webinterface test functions)</p></li>
<li><p>VolumeSet (sets the volume to value from 0-100 percent)</p></li>
</ul>
Expand Down Expand Up @@ -5612,7 +5612,7 @@ <h3>Needed software<a class="headerlink" href="#needed-software" title="Permalin
<ul class="simple">
<li><p>smarthomeNg 1.5.2 and above for the web-interface</p></li>
<li><p>needs Python requests</p></li>
<li><p>a valid <a class="reference internal" href="#cookie"><span class="xref myst">Cookie</span></a> from an alexa.amazon-Web-Site Session</p></li>
<li><p>a valid Cookie from an alexa.amazon-Web-Site Session</p></li>
<li><p>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>“user.test&#64;gmail.com:your_pwd“</strong> you will get <strong><code class="docutils literal notranslate"><span class="pre">dXNlci50ZXN0QGdtYWlsLmNvbTp5b3VyX3B3ZA==</span></code> </strong>.
So please enter <strong><code class="docutils literal notranslate"><span class="pre">dXNlci50ZXN0QGdtYWlsLmNvbTp5b3VyX3B3ZA==</span></code></strong> in the /etc/plugin.yaml</p></li>
</ul>
Expand Down Expand Up @@ -5789,7 +5789,7 @@ <h3>send_cmd(dvName:str, cmdName:str, mValue:str)<a class="headerlink" href="#se
</div>
<p>Sends a command to the device. „dvName“ is the name of the device, „cmdName“ is the name of the CommandLet, mValue is the value you would send.
You can find all this informations on the Web-Interface.
You can also use the <a class="reference internal" href="#placeholders"><span class="xref myst">placeholders</span></a></p>
You can also use the placeholders</p>
<ul class="simple">
<li><p>the result will be the HTTP-Status of the request as string (str)</p></li>
</ul>
Expand Down Expand Up @@ -5853,7 +5853,7 @@ <h2>Example to show lists in smartVisu with status.activelist<a class="headerlin
</pre>
<section id="ergebnis">
<h3>Ergebnis :<a class="headerlink" href="#ergebnis" title="Permalink to this heading"></a></h3>
<p><img alt="PlaceHolder" src="../../_images/Alexa_lists.jpg" /></p>
<p>!PlaceHolder</p>
</section>
</section>
</section>
Expand All @@ -5868,12 +5868,12 @@ <h2>Cookie-Handling<a class="headerlink" href="#cookie-handling" title="Permalin
Paste it to the textarea in the Web-Interface and Store it.</p>
<p>Now the available devices from your alexa-account will be discoverd an shown on the second tab.</p>
<p>You can also login / logoff when credentials are available. Please see results in the textarea on the right. Please refresh page manually after successfull login via the Web-Interface.</p>
<p><img alt="PlaceHolder" src="../../_images/webif1.jpg" /></p>
<p>!PlaceHolder</p>
</section>
<section id="alexa-devices">
<h2>Alexa devices<a class="headerlink" href="#alexa-devices" title="Permalink to this heading"></a></h2>
<p>By click on one device the device will be selected as acutal device for tests.
<img alt="PlaceHolder" src="../../_images/webif2.jpg" /></p>
!PlaceHolder</p>
</section>
<section id="command-handling">
<h2>Command-Handling<a class="headerlink" href="#command-handling" title="Permalink to this heading"></a></h2>
Expand All @@ -5883,7 +5883,7 @@ <h2>Command-Handling<a class="headerlink" href="#command-handling" title="Permal
<p>When you click on an existing Command-Let it will be load to the Web-Interface.</p>
<p>You can enter test values in the field for the values. Press Test and the command will be send to the device. You get back the HTTP-Status of the Request.</p>
<p><strong>For test dont modify the payload, just use the test-value-field </strong></p>
<p><img alt="PlaceHolder" src="../../_images/webif3.jpg" />
<p>!PlaceHolder
<br></p>
</section>
<section id="how-to-create-new-command-lets-spy-out-the-amazon-web-interface">
Expand Down
14 changes: 7 additions & 7 deletions plugins/mieleathome/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -5491,13 +5491,13 @@ <h2>Version 1.0.0<a class="headerlink" href="#version-1-0-0" title="Permalink to
<section id="table-of-content">
<h2>table of content<a class="headerlink" href="#table-of-content" title="Permalink to this heading"></a></h2>
<ol class="arabic simple">
<li><p><a class="reference internal" href="#changelog"><span class="xref myst">Change Log</span></a></p></li>
<li><p><a class="reference internal" href="#activate"><span class="xref myst">Aktivierung des Zugriffs für 3rd party-Apps</span></a></p></li>
<li><p><a class="reference internal" href="#plugin_yaml"><span class="xref myst">Einstellungen in der plugin.yaml</span></a></p></li>
<li><p><a class="reference internal" href="#device_id"><span class="xref myst">Ermittln der Device-ID´s</span></a></p></li>
<li><p><a class="reference internal" href="#create_items"><span class="xref myst">Items definieren</span></a></p></li>
<li><p><a class="reference internal" href="#visu"><span class="xref myst">Darstellung in der VISU</span></a></p></li>
<li><p><a class="reference internal" href="#issues"><span class="xref myst">known issues</span></a></p></li>
<li><p>Change Log</p></li>
<li><p>Aktivierung des Zugriffs für 3rd party-Apps</p></li>
<li><p>Einstellungen in der plugin.yaml</p></li>
<li><p>Ermittln der Device-ID´s</p></li>
<li><p>Items definieren</p></li>
<li><p>Darstellung in der VISU</p></li>
<li><p>known issues</p></li>
</ol>
</section>
<section id="changelog">
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 65d0ffb

Please sign in to comment.