</parameter-group>
<!-- Parameters -->
- <parameter name="subscriptionKey" groupName="subscription" type="text" pattern="[0-9a-f]{32}">
+ <parameter name="subscriptionKey" groupName="subscription" type="text" pattern="[0-9a-f]{32}"
+ required="true">
<label>Subscription Key</label>
<description>This is the Subscription Key provided by BTicino/Legrand when you subscribe to Smarther - v2.0 product.
Go to https://developer.legrand.com/tutorials/getting-started/</description>
- <required>true</required>
</parameter>
<parameter name="clientId" groupName="application" type="text"
- pattern="[0-9a-f]{8}[-]([0-9a-f]{4}[-]){3}[0-9a-f]{12}">
+ pattern="[0-9a-f]{8}[-]([0-9a-f]{4}[-]){3}[0-9a-f]{12}" required="true">
<label>Client ID</label>
<description>This is the Client ID provided by BTicino/Legrand when you add a new Application to your developer
account. Go to https://developer.legrand.com/tutorials/create-an-application/</description>
- <required>true</required>
</parameter>
- <parameter name="clientSecret" groupName="application" type="text">
+ <parameter name="clientSecret" groupName="application" type="text" required="true">
<label>Client Secret</label>
<description>This is the Client Secret provided by BTicino/Legrand when you add a new Application to your developer
account.</description>
- <required>true</required>
<context>password</context>
</parameter>
- <parameter name="useNotifications" groupName="advancedset" type="boolean">
+ <parameter name="useNotifications" groupName="advancedset" type="boolean" required="false">
<label>Use Notifications</label>
<description>ON = the bridge subscribes each of its locations to receive C2C notifications upon changes on each of
its modules' status or sensors data - temperature, humidity (requires a public https endpoint has been set as "First
Reply Url" when registering the Application on Legrand's development portal); OFF = for each module connected to
this bridge, status+sensors data are requested to Smarther API gateway on a periodical basis and whenever new
settings are applied (period can be changed via module's "Status Refresh Period" parameter).</description>
- <required>false</required>
<advanced>true</advanced>
<default>true</default>
</parameter>
- <parameter name="statusRefreshPeriod" groupName="advancedset" type="integer" min="1" unit="min">
+ <parameter name="statusRefreshPeriod" groupName="advancedset" type="integer" min="1" unit="min"
+ required="false">
<label>Bridge Status Refresh Period (minutes)</label>
<description>This is the frequency the Smarther API gateway is called to update bridge status. There are limits to
the number of requests that can be sent to the Smarther API gateway. The more often you poll, the faster locations
are updated - at the risk of running out of your request quota.</description>
- <required>false</required>
<advanced>true</advanced>
<unitLabel>Minutes</unitLabel>
<default>1440</default>
<!-- Parameters -->
<parameter name="plantId" groupName="topology" type="text"
- pattern="[0-9a-f]{8}[-]([0-9a-f]{4}[-]){3}[0-9a-f]{12}">
+ pattern="[0-9a-f]{8}[-]([0-9a-f]{4}[-]){3}[0-9a-f]{12}" required="true">
<label>Location Plant Id</label>
<description>This is the Plant Id of the location the Chronothermostat module is installed in, provided by Smarther
API.</description>
- <required>true</required>
</parameter>
<parameter name="moduleId" groupName="topology" type="text"
- pattern="[0-9a-f]{8}[-]([0-9a-f]{4}[-]){3}[0-9a-f]{12}">
+ pattern="[0-9a-f]{8}[-]([0-9a-f]{4}[-]){3}[0-9a-f]{12}" required="true">
<label>Chronothermostat Module Id</label>
<description>This is the Module Id of the Chronothermostat module, provided by Smarther API.</description>
- <required>true</required>
</parameter>
- <parameter name="settingsAutoupdate" groupName="advancedset" type="boolean">
+ <parameter name="settingsAutoupdate" groupName="advancedset" type="boolean" required="false">
<label>Module Settings Auto-Update</label>
<description>ON = the module settings are automatically updated according to the module status whenever it changes
(e.g. polling, notification, etc.). OFF = the module settings are aligned to the module status only upon module
initialization.</description>
- <required>false</required>
<advanced>true</advanced>
<default>false</default>
</parameter>
- <parameter name="programsRefreshPeriod" groupName="advancedset" type="integer" min="1" unit="h">
+ <parameter name="programsRefreshPeriod" groupName="advancedset" type="integer" min="1" unit="h"
+ required="false">
<label>Programs Refresh Period (hours)</label>
<description>This is the frequency the Smarther API gateway is called to refresh Programs list used in "automatic"
mode. There are limits to the number of requests that can be sent to the Smarther API gateway. The more often you
poll, the faster locations are updated - at the risk of running out of your request quota.</description>
- <required>false</required>
<advanced>true</advanced>
<unitLabel>Hours</unitLabel>
<default>12</default>
</parameter>
- <parameter name="numberOfEndDays" groupName="advancedset" type="integer" min="1" max="9">
+ <parameter name="numberOfEndDays" groupName="advancedset" type="integer" min="1" max="9" required="false">
<label>Number Of Days For End Date</label>
<description>This is the number of days to be displayed in module settings, as options list for "End Date" field in
"manual" mode (e.g. 1 = only "Today" is displayed, 5 = "Today" + "Tomorrow" + following 3 days are displayed).</description>
- <required>false</required>
<advanced>true</advanced>
<default>5</default>
</parameter>
- <parameter name="statusRefreshPeriod" groupName="advancedset" type="integer" min="1" unit="min">
+ <parameter name="statusRefreshPeriod" groupName="advancedset" type="integer" min="1" unit="min"
+ required="false">
<label>Module Status Refresh Period (minutes)</label>
<description>This is the frequency the Smarther API gateway is called to update module status and sensors data. There
are limits to the number of requests that can be sent to the Smarther API gateway. The more often you poll, the
faster locations are updated - at the risk of running out of your request quota.</description>
- <required>false</required>
<advanced>true</advanced>
<unitLabel>Minutes</unitLabel>
<default>60</default>
projects / openhab-addons.git / commitdiff