From 1a42353cc9b44800768770542bfea58536a70ed6 Mon Sep 17 00:00:00 2001 From: lsiepel Date: Sat, 28 Sep 2024 17:46:53 +0200 Subject: [PATCH] Multiple binding markdown fixes (#17422) Signed-off-by: Leo Siepel --- .../README.md | 2 +- .../README.md | 2 +- .../README.md | 2 +- .../README.md | 6 +- .../org.openhab.binding.androidtv/README.md | 12 +- .../org.openhab.binding.argoclima/README.md | 64 ++-- bundles/org.openhab.binding.atlona/README.md | 2 +- .../org.openhab.binding.avmfritz/README.md | 6 +- .../README.md | 2 +- .../README.md | 2 +- .../README.md | 2 +- .../README.md | 2 +- .../README.md | 4 +- .../org.openhab.binding.boschshc/README.md | 8 +- bundles/org.openhab.binding.caddx/README.md | 2 +- bundles/org.openhab.binding.chatgpt/README.md | 4 +- bundles/org.openhab.binding.cm11a/README.md | 4 +- bundles/org.openhab.binding.dbquery/README.md | 12 +- bundles/org.openhab.binding.deconz/README.md | 2 +- .../README.md | 50 +-- .../README.md | 2 +- bundles/org.openhab.binding.dmx/README.md | 6 +- bundles/org.openhab.binding.dolbycp/README.md | 6 +- .../org.openhab.binding.dominoswiss/README.md | 8 +- .../org.openhab.binding.doorbird/README.md | 2 +- .../org.openhab.binding.dscalarm/README.md | 10 +- .../README.md | 2 +- .../org.openhab.binding.dwdunwetter/README.md | 2 +- bundles/org.openhab.binding.ekey/README.md | 1 + .../README.md | 2 +- bundles/org.openhab.binding.emotiva/README.md | 26 +- .../org.openhab.binding.energenie/README.md | 2 +- .../README.md | 6 +- bundles/org.openhab.binding.enigma2/README.md | 8 +- bundles/org.openhab.binding.enocean/README.md | 16 +- .../org.openhab.binding.ephemeris/README.md | 14 +- .../org.openhab.binding.etherrain/README.md | 6 +- bundles/org.openhab.binding.evcc/README.md | 20 +- bundles/org.openhab.binding.evohome/README.md | 6 +- bundles/org.openhab.binding.exec/README.md | 2 +- bundles/org.openhab.binding.fenecon/README.md | 4 +- .../README.md | 4 +- bundles/org.openhab.binding.flume/README.md | 8 +- .../org.openhab.binding.fmiweather/README.md | 32 +- bundles/org.openhab.binding.fronius/README.md | 5 +- .../org.openhab.binding.ftpupload/README.md | 8 +- bundles/org.openhab.binding.gce/README.md | 4 +- .../README.md | 4 +- .../org.openhab.binding.globalcache/README.md | 2 +- .../org.openhab.binding.goecharger/README.md | 2 +- bundles/org.openhab.binding.govee/README.md | 2 +- bundles/org.openhab.binding.gpio/README.md | 14 +- bundles/org.openhab.binding.gree/README.md | 4 +- bundles/org.openhab.binding.gridbox/README.md | 28 +- bundles/org.openhab.binding.growatt/README.md | 4 +- .../README.md | 4 +- .../README.md | 2 +- bundles/org.openhab.binding.helios/README.md | 2 +- .../org.openhab.binding.homeconnect/README.md | 26 +- .../org.openhab.binding.homematic/README.md | 9 +- .../org.openhab.binding.hpprinter/README.md | 2 +- bundles/org.openhab.binding.hue/README.md | 2 +- .../org.openhab.binding.hydrawise/README.md | 8 +- .../org.openhab.binding.hyperion/README.md | 2 +- bundles/org.openhab.binding.ihc/README.md | 6 +- bundles/org.openhab.binding.insteon/README.md | 2 +- bundles/org.openhab.binding.intesis/README.md | 4 +- .../org.openhab.binding.iotawatt/README.md | 2 +- .../org.openhab.binding.ipcamera/README.md | 14 +- bundles/org.openhab.binding.irtrans/README.md | 2 +- bundles/org.openhab.binding.ism8/README.md | 44 +-- .../org.openhab.binding.jablotron/README.md | 4 +- .../README.md | 18 +- bundles/org.openhab.binding.keba/README.md | 6 +- bundles/org.openhab.binding.knx/README.md | 6 +- .../org.openhab.binding.konnected/README.md | 2 +- .../README.md | 18 +- .../README.md | 12 +- .../org.openhab.binding.leapmotion/README.md | 2 +- bundles/org.openhab.binding.lgwebos/README.md | 2 +- bundles/org.openhab.binding.luxom/README.md | 2 +- .../org.openhab.binding.mecmeter/README.md | 4 +- .../org.openhab.binding.mercedesme/README.md | 64 ++-- .../proto/README.md | 2 +- bundles/org.openhab.binding.mffan/README.md | 4 +- bundles/org.openhab.binding.mihome/README.md | 6 +- bundles/org.openhab.binding.miio/README.md | 4 +- .../org.openhab.binding.millheat/README.md | 6 +- .../org.openhab.binding.modbus.e3dc/README.md | 10 +- .../README.md | 6 +- .../README.md | 2 +- bundles/org.openhab.binding.modbus/README.md | 92 +++--- .../README.md | 14 +- .../README.md | 4 +- bundles/org.openhab.binding.mybmw/README.md | 292 +++++++++--------- bundles/org.openhab.binding.mycroft/README.md | 2 +- bundles/org.openhab.binding.mynice/README.md | 2 +- bundles/org.openhab.binding.mystrom/README.md | 6 +- .../org.openhab.binding.nanoleaf/README.md | 44 +-- bundles/org.openhab.binding.neato/README.md | 2 +- bundles/org.openhab.binding.neeo/README.md | 8 +- bundles/org.openhab.binding.neohub/README.md | 8 +- bundles/org.openhab.binding.netatmo/README.md | 11 +- bundles/org.openhab.binding.network/README.md | 8 +- .../contrib/NibeGW/Arduino/README.md | 27 +- bundles/org.openhab.binding.nikobus/README.md | 6 +- bundles/org.openhab.binding.nobohub/README.md | 8 +- bundles/org.openhab.binding.nuki/README.md | 16 +- bundles/org.openhab.binding.nuvo/README.md | 24 +- bundles/org.openhab.binding.oceanic/README.md | 10 +- bundles/org.openhab.binding.onewire/README.md | 24 +- .../org.openhab.binding.opengarage/README.md | 6 +- bundles/org.openhab.binding.openuv/README.md | 12 +- .../doc/icon/ozone.svg | 15 + .../doc/icon/uv-alarm.svg | 15 + .../doc/icon/uv-index.svg | 50 +++ .../org.openhab.binding.openwebnet/README.md | 24 +- .../org.openhab.binding.orbitbhyve/README.md | 58 ++-- .../README.md | 38 +-- .../README.md | 60 ++-- .../org.openhab.binding.pegelonline/README.md | 65 ++-- bundles/org.openhab.binding.pentair/README.md | 6 +- bundles/org.openhab.binding.phc/README.md | 6 +- bundles/org.openhab.binding.pihole/README.md | 10 +- bundles/org.openhab.binding.plex/README.md | 16 +- bundles/org.openhab.binding.prowl/README.md | 12 +- .../README.md | 4 +- .../org.openhab.binding.pulseaudio/README.md | 6 +- .../org.openhab.binding.pushover/README.md | 5 +- .../org.openhab.binding.qolsysiq/README.md | 4 +- .../README.md | 2 +- .../README.md | 8 +- bundles/org.openhab.binding.renault/README.md | 2 +- bundles/org.openhab.binding.rfxcom/README.md | 4 +- bundles/org.openhab.binding.roku/README.md | 62 ++-- .../org.openhab.binding.sagercaster/README.md | 2 +- .../org.openhab.binding.saicismart/README.md | 6 +- .../org.openhab.binding.samsungtv/README.md | 90 +++--- bundles/org.openhab.binding.satel/README.md | 2 +- bundles/org.openhab.binding.sensibo/README.md | 4 +- .../README.md | 38 +-- bundles/org.openhab.binding.shelly/README.md | 10 +- .../org.openhab.binding.siemenshvac/README.md | 32 +- bundles/org.openhab.binding.sinope/README.md | 4 +- bundles/org.openhab.binding.snmp/README.md | 8 +- .../org.openhab.binding.solaredge/README.md | 10 +- .../README.md | 80 ++--- .../org.openhab.binding.solarman/README.md | 10 +- .../org.openhab.binding.solarwatt/README.md | 7 +- bundles/org.openhab.binding.solax/README.md | 14 +- bundles/org.openhab.binding.somneo/README.md | 5 +- bundles/org.openhab.binding.souliss/README.md | 18 +- .../org.openhab.binding.surepetcare/README.md | 4 +- .../org.openhab.binding.tapocontrol/README.md | 6 +- .../org.openhab.binding.tasmotaplug/README.md | 6 +- bundles/org.openhab.binding.tesla/README.md | 18 +- .../README.md | 8 +- .../org.openhab.binding.teslascope/README.md | 16 +- bundles/org.openhab.binding.tibber/README.md | 2 +- bundles/org.openhab.binding.tivo/README.md | 112 +++---- bundles/org.openhab.binding.tr064/README.md | 6 +- bundles/org.openhab.binding.tradfri/README.md | 13 +- .../org.openhab.binding.upnpcontrol/README.md | 18 +- bundles/org.openhab.binding.velbus/README.md | 6 +- .../README.md | 2 +- bundles/org.openhab.binding.vesync/README.md | 8 +- .../README.md | 62 ++-- bundles/org.openhab.binding.vizio/README.md | 74 ++--- bundles/org.openhab.binding.volumio/README.md | 2 +- .../org.openhab.binding.volvooncall/README.md | 6 +- bundles/org.openhab.binding.warmup/README.md | 35 +-- .../org.openhab.binding.webexteams/README.md | 2 +- .../org.openhab.binding.webthing/README.md | 8 +- bundles/org.openhab.binding.wemo/README.md | 12 +- bundles/org.openhab.binding.wifiled/README.md | 10 +- .../org.openhab.binding.wlanthermo/README.md | 56 ++-- bundles/org.openhab.binding.wled/README.md | 4 +- .../README.md | 4 +- .../README.md | 4 +- .../docs/README.md | 43 +-- .../org.openhab.binding.zoneminder/README.md | 2 +- bundles/org.openhab.io.homekit/README.md | 49 +-- bundles/org.openhab.io.hueemulation/README.md | 64 ++-- bundles/org.openhab.io.metrics/README.md | 28 +- bundles/org.openhab.io.neeo/README.md | 26 +- bundles/org.openhab.io.openhabcloud/README.md | 27 +- .../README.md | 16 +- .../org.openhab.persistence.jdbc/README.md | 38 +-- .../org.openhab.persistence.rrd4j/README.md | 8 +- .../org.openhab.transform.bin2json/README.md | 4 +- bundles/org.openhab.transform.exec/README.md | 8 +- bundles/org.openhab.transform.jinja/README.md | 8 +- .../org.openhab.transform.jsonpath/README.md | 4 +- bundles/org.openhab.transform.scale/README.md | 6 +- bundles/org.openhab.transform.xpath/README.md | 28 +- bundles/org.openhab.transform.xslt/README.md | 48 +-- bundles/org.openhab.voice.googlestt/README.md | 48 +-- bundles/org.openhab.voice.googletts/README.md | 36 ++- bundles/org.openhab.voice.mactts/README.md | 10 +- bundles/org.openhab.voice.marytts/README.md | 11 +- bundles/org.openhab.voice.mimictts/README.md | 20 +- bundles/org.openhab.voice.picotts/README.md | 12 +- bundles/org.openhab.voice.pipertts/README.md | 16 +- bundles/org.openhab.voice.pollytts/README.md | 38 +-- .../org.openhab.voice.rustpotterks/README.md | 2 +- bundles/org.openhab.voice.voicerss/README.md | 212 ++++++------- bundles/org.openhab.voice.voskstt/README.md | 30 +- bundles/org.openhab.voice.watsonstt/README.md | 40 +-- .../org.openhab.voice.whisperstt/README.md | 97 +++--- 209 files changed, 1889 insertions(+), 1805 deletions(-) create mode 100644 bundles/org.openhab.binding.openuv/doc/icon/ozone.svg create mode 100644 bundles/org.openhab.binding.openuv/doc/icon/uv-alarm.svg create mode 100644 bundles/org.openhab.binding.openuv/doc/icon/uv-index.svg diff --git a/bundles/org.openhab.automation.groovyscripting/README.md b/bundles/org.openhab.automation.groovyscripting/README.md index f25ff112e6d..39fa2fd5a09 100644 --- a/bundles/org.openhab.automation.groovyscripting/README.md +++ b/bundles/org.openhab.automation.groovyscripting/README.md @@ -23,7 +23,7 @@ For more information on the available APIs in scripts see the [JSR223 Scripting] ## Code reuse -One can place *.groovy files with Groovy classes under `automation/groovy` configuration directory. +One can place *.groovy files with Groovy classes under `automation/groovy` configuration directory. Those classes can be imported in JSR-223 scripts or the UI rules action with the usual Groovy `import` statement. To apply shared code changes, one has to restart the `openHAB Core :: Bundles :: Automation` bundle on the Console or an openHAB instance altogether. diff --git a/bundles/org.openhab.automation.jrubyscripting/README.md b/bundles/org.openhab.automation.jrubyscripting/README.md index cc81982ea5e..5ef835eddde 100644 --- a/bundles/org.openhab.automation.jrubyscripting/README.md +++ b/bundles/org.openhab.automation.jrubyscripting/README.md @@ -670,7 +670,7 @@ items.build do # dimension Temperature inferred number_item OutdoorTemp, format: "%.1f %unit%", unit: "°F" - + # unit lx, dimension Illuminance, format "%s %unit%" inferred number_item OutdoorBrightness, state: 10_000 | "lx" end diff --git a/bundles/org.openhab.binding.ahawastecollection/README.md b/bundles/org.openhab.binding.ahawastecollection/README.md index 89f44ff3872..13da5bcf6b5 100644 --- a/bundles/org.openhab.binding.ahawastecollection/README.md +++ b/bundles/org.openhab.binding.ahawastecollection/README.md @@ -55,7 +55,7 @@ The thing **aha Waste Collection Schedule** provides four channels for the upcom wasteCollection.things ```java -Thing ahawastecollection:collectionSchedule:wasteCollectionSchedule "aha Abfuhrkalender" [ commune="Isernhagen", street="67269@Rosmarinweg+/+Kirchhorst@Kirchhorst", houseNumber="10", houseNumberAddon="", collectionPlace="67269-0010+" ] +Thing ahawastecollection:collectionSchedule:wasteCollectionSchedule "aha Abfuhrkalender" [ commune="Isernhagen", street="67269@Rosmarinweg+/+Kirchhorst@Kirchhorst", houseNumber="10", houseNumberAddon="", collectionPlace="67269-0010+" ] ``` wasteCollection.items diff --git a/bundles/org.openhab.binding.amberelectric/README.md b/bundles/org.openhab.binding.amberelectric/README.md index f856eddbd42..0a411522943 100644 --- a/bundles/org.openhab.binding.amberelectric/README.md +++ b/bundles/org.openhab.binding.amberelectric/README.md @@ -4,7 +4,7 @@ A binding that supports the Australian energy retailer Amber's API ( openhab:androidtv androidtv:googletv:theater keypress KEY_POWER ## Pin Code Process -For the AndroidTV to be successfully accessed an on-screen PIN authentication is required on the first connection. +For the AndroidTV to be successfully accessed an on-screen PIN authentication is required on the first connection. To begin the PIN process, send the text "REQUEST" to the pincode channel while watching your AndroidTV. -CLI Example Usage: +CLI Example Usage: ```shell openhab> openhab:androidtv androidtv:googletv:theater pincode REQUEST diff --git a/bundles/org.openhab.binding.argoclima/README.md b/bundles/org.openhab.binding.argoclima/README.md index 3215dc6965e..590de6b86bc 100644 --- a/bundles/org.openhab.binding.argoclima/README.md +++ b/bundles/org.openhab.binding.argoclima/README.md @@ -123,23 +123,23 @@ Thing argoclima:local:argoHvacLocalDirect "Argo HVAC (connected locally)" @ "Liv Thing argoclima:local:argoHvacLocalDirectEx "Argo HVAC (connected locally) - extended example (with explicit options)" [ hostname="192.168.0.3", connectionMode="LOCAL_CONNECTION", - refreshInterval=30, + refreshInterval=30, hvacListenPort=1001, // Schedule options (these are valid for all thing types) - schedule1DayOfWeek="[FRI, SAT, SUN, MON]", - schedule1OnTime="7:35", + schedule1DayOfWeek="[FRI, SAT, SUN, MON]", + schedule1OnTime="7:35", schedule1OffTime="18:00", - schedule2DayOfWeek="[MON, TUE, WED, THU, FRI]", + schedule2DayOfWeek="[MON, TUE, WED, THU, FRI]", schedule2OnTime="15:00", schedule2OffTime="22:00", schedule3DayOfWeek="SUN","SAT", //Alternative syntax for the weekdays list - schedule3OnTime="11:00", - schedule3OffTime="22:00" + schedule3OnTime="11:00", + schedule3OffTime="22:00" //,resetToFactoryDefaults=true //This triggers a one-shot command each time the thing - // definition is (re)loaded from file. + // definition is (re)loaded from file. // Use only intermittently - it is not designed with prolonged - // usage via Things text file in mind (mostly a MainUI feature!) + // usage via Things text file in mind (mostly a MainUI feature!) ] //ADVANCED MODES examples @@ -153,19 +153,19 @@ Thing argoclima:local:argoHvacLocalWithPassthroughIndirect "Argo HVAC (accessibl Thing argoclima:local:argoHvacLocalWithPassthroughPlusDirectEx "Argo HVAC (accessible both indirectly and directly, via pass-through mode, with explicit options)" [ hostname="192.168.0.3", // Direct address of the device (reachable from openHAB) connectionMode="REMOTE_API_PROXY", - + hvacListenPort=1001, refreshInterval=30, useLocalConnection=true, - + // Stub server-specific - stubServerPort=8240, - stubServerListenAddresses="7d47:86bd:0bfe:0413:4688:4523:4284:5936","192.168.0.195", - includeDeviceSidePasswordsInProperties="MASKED", - matchAnyIncomingDeviceIp=false, + stubServerPort=8240, + stubServerListenAddresses="7d47:86bd:0bfe:0413:4688:4523:4284:5936","192.168.0.195", + includeDeviceSidePasswordsInProperties="MASKED", + matchAnyIncomingDeviceIp=false, deviceCpuId="deadbeefdeadbeef", // For direct match to a concrete device (optional) localDeviceIP="192.168.4.2", // Address in local subnet (used for indirect request matching) - + // Pass-through-specific oemServerAddress="uisetup.ddns.net", oemServerPort=80 @@ -174,7 +174,7 @@ Thing argoclima:local:argoHvacLocalWithPassthroughPlusDirectEx "Argo HVAC (acces Thing argoclima:local:argoHvacLocalWithStub "Argo HVAC (accessible both indirectly and directly with a stub) - **RECOMMENDED MODE**" [ hostname="192.168.0.3", // Has to be reachable, since useLocalConnection is true (default) - connectionMode="REMOTE_API_STUB", + connectionMode="REMOTE_API_STUB", localDeviceIP="192.168.4.2" // Or use matchAnyIncomingDeviceIp=true ] ``` @@ -185,11 +185,11 @@ Thing argoclima:local:argoHvacLocalWithStub "Argo HVAC (accessible both indirect Group GArgoClimaHVACRemote "Ulisse 13 DCI ECO - remote mode" ["HVAC"] Switch ArgoClimaHVACRemote_Power "Power" (GArgoClimaHVACRemote) { - channel="argoclima:remote:argoHvacRemote:ac-controls#power" + channel="argoclima:remote:argoHvacRemote:ac-controls#power" } String ArgoClimaHVACRemote_Mode "Mode" (GArgoClimaHVACRemote) ["Control"] { - channel="argoclima:remote:argoHvacRemote:ac-controls#mode" + channel="argoclima:remote:argoHvacRemote:ac-controls#mode" } Number:Temperature ArgoClimaHVACRemote_SetTemperature "Set Temperature" (GArgoClimaHVACRemote) ["Temperature", "Setpoint"] { @@ -201,27 +201,27 @@ Number:Temperature ArgoClimaHVACRemote_SetTemperature "Set Temperature" (GArgoClimaHVACRemote) ["Temperature", "Measurement"] { - channel="argoclima:remote:argoHvacRemote:ac-controls#current-temperature" + channel="argoclima:remote:argoHvacRemote:ac-controls#current-temperature" } String ArgoClimaHVACRemote_FanSpeed "Fan Speed" (GArgoClimaHVACRemote) { - channel="argoclima:remote:argoHvacRemote:ac-controls#fan-speed" + channel="argoclima:remote:argoHvacRemote:ac-controls#fan-speed" } Switch ArgoClimaHVACRemote_EcoMode "Eco Mode" (GArgoClimaHVACRemote) { - channel="argoclima:remote:argoHvacRemote:modes#eco-mode" + channel="argoclima:remote:argoHvacRemote:modes#eco-mode" } Switch ArgoClimaHVACRemote_TurboMode "Turbo Mode" (GArgoClimaHVACRemote) { - channel="argoclima:remote:argoHvacRemote:modes#turbo-mode" + channel="argoclima:remote:argoHvacRemote:modes#turbo-mode" } Switch ArgoClimaHVACRemote_NightMode "Night Mode" (GArgoClimaHVACRemote) { - channel="argoclima:remote:argoHvacRemote:modes#night-mode" + channel="argoclima:remote:argoHvacRemote:modes#night-mode" } String ArgoClimaHVACRemote_ActiveTimer "Active timer" (GArgoClimaHVACRemote) { - channel="argoclima:remote:argoHvacRemote:timers#active-timer" + channel="argoclima:remote:argoHvacRemote:timers#active-timer" } Number:Time ArgoClimaHVACRemote_DelayTimer "Delay timer value"