Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

link to http api pdf #657

Merged
merged 2 commits into from
Mar 4, 2025
Merged

link to http api pdf #657

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57fc2a5
link to http api pdf
LKuemmel Mar 4, 2025
21e29cc
Update src/views/GeneralConfig.vue
LKuemmel Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 12 additions & 64 deletions src/views/GeneralConfig.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,70 +108,18 @@
>
<template #help>
<p>
Mit der HTTP-API kann man den Wert eines MQTT-Topics per HTTPs (Port 8443) abfragen oder neu setzen.
Topics können über GET oder POST abgefragt, neue Werte nur mit POST gesetzt werden.
</p>
<p>Beispiel 1: Abfrage des aktuellen Systemzeitstempels</p>
<ul>
<li>
GET-Request:<br />
<openwb-base-copy-to-clipboard
class="text-info"
tooltip="URL kopieren"
>
https://{{ getIpAddress() }}:8443/v1/?topic=openWB/system/time
</openwb-base-copy-to-clipboard>
</li>
<li>
POST-Request über 'curl' mit privatem SSL-Zertifikat und Verarbeitung durch 'jq':<br />
<openwb-base-copy-to-clipboard
class="text-info"
tooltip="Befehl kopieren"
>
curl -k -s -X POST --data '{"topic":"openWB/system/time"}' https://{{ getIpAddress() }}:8443/v1/ |
jq .
</openwb-base-copy-to-clipboard>
</li>
</ul>
<p>Die zurückgegebenen Daten sind im JSON-Format. Der Inhalt ist nach folgendem Schema aufgebaut:</p>
<pre class="border border-info w-100 p-1">{{
JSON.stringify(
{
status: "success",
topic: "openWB/system/time",
message: 1721287000.646975,
},
null,
4,
)
}}</pre>
<p>Im Fehlerfall wird der Status auf "failed" gesetzt und eine Fehlermeldung zurückgegeben.</p>
<p>Beispiel 2: integriertes Display abschalten</p>
<ul>
<li>
POST-Request über 'curl' mit privatem SSL-Zertifikat und Verarbeitung durch 'jq':<br />
<openwb-base-copy-to-clipboard
class="text-info"
tooltip="Befehl kopieren"
>
curl -k -s -X POST --data '{"topic": "openWB/set/optional/int_display/active", "message": false}'
https://{{ getIpAddress() }}:8443/v1/ | jq .
</openwb-base-copy-to-clipboard>
</li>
</ul>
<p>Die zurückgegebenen Daten sind im JSON-Format. Der Inhalt ist nach folgendem Schema aufgebaut:</p>
<pre class="border border-info w-100 p-1">{{
JSON.stringify(
{
status: "success",
topic: "openWB/set/optional/int_display/active",
message: false,
},
null,
4,
)
}}</pre>
</template>
Mit der HTTP-API kann man den Wert eines MQTT-Topics per HTTPs abfragen oder neu setzen. Die
Schnittstelle ist
<a
href="https://openwb.de/main/wp-content/uploads/2025/02/HTTP-API-fuer-openWB-series1-und-series2.pdf"
target="_blank"
rel="noopener noreferrer"
>
hier
</a>
dokumentiert.
</p></template
>
</openwb-base-button-group-input>
</div>
</openwb-base-card>
Expand Down
Loading