2073 lines
83 KiB
HTML
Executable File
2073 lines
83 KiB
HTML
Executable File
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="generator" content="JsDoc Toolkit" />
|
|
<title>hcap.iot | JsDoc Reference</title>
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
|
|
<meta name="mobileoptimized" content="0" />
|
|
|
|
<link rel="stylesheet" href="../css/all.css" media="all" />
|
|
<link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)" />
|
|
<link rel="stylesheet" href="../css/handheld.css" media="handheld" />
|
|
<link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)" />
|
|
|
|
<link rel="stylesheet" href="../javascript/highlighter/dessert.css" />
|
|
|
|
<script src="../javascript/all.js"></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../javascript/html5.js"></script>
|
|
<![endif]-->
|
|
|
|
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="index">
|
|
<div class="menu">
|
|
<div class="indexLinks">
|
|
<a href="../index.html">Classes</a>
|
|
<a href="../files.html">Files</a>
|
|
</div>
|
|
<table width=100% class=confidential><tr><td><b>LGE Confidential</b></td></tr></table>
|
|
<h2 class="heading1">Library</h2>
|
|
<table>
|
|
<tr>
|
|
<td align=left class=confidential><a href="../../js/hcap.js">·hcap.js (1.24.6.5901)</li></a></td>
|
|
</tr>
|
|
</table>
|
|
<h2 class="heading1">Classes</h2>
|
|
|
|
<input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
|
|
|
|
<nav>
|
|
<ul class="classList" id="ClassList">
|
|
|
|
<li><a href="../symbols/_global_.html">_global_</a></li>
|
|
|
|
<li><a href="../symbols/hcap.html">hcap</a></li>
|
|
|
|
<li><a href="../symbols/hcap.application.html">hcap<span class='break'> </span>.<span class='break'> </span>application</a></li>
|
|
|
|
<li><a href="../symbols/hcap.beacon.html">hcap<span class='break'> </span>.<span class='break'> </span>beacon</a></li>
|
|
|
|
<li><a href="../symbols/hcap.bluetooth.html">hcap<span class='break'> </span>.<span class='break'> </span>bluetooth</a></li>
|
|
|
|
<li><a href="../symbols/hcap.bluetooth.audio.html">hcap<span class='break'> </span>.<span class='break'> </span>bluetooth<span class='break'> </span>.<span class='break'> </span>audio</a></li>
|
|
|
|
<li><a href="../symbols/hcap.camera.html">hcap<span class='break'> </span>.<span class='break'> </span>camera</a></li>
|
|
|
|
<li><a href="../symbols/hcap.carousel.html">hcap<span class='break'> </span>.<span class='break'> </span>carousel</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.html">hcap<span class='break'> </span>.<span class='break'> </span>channel</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.AudioStreamType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>AudioStreamType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.ChannelStatus.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>ChannelStatus</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.ChannelType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>ChannelType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.InbandDataServiceType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>InbandDataServiceType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.IpBroadcastType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>IpBroadcastType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.Polarization.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>Polarization</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.RfBroadcastType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>RfBroadcastType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.VideoStreamType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>VideoStreamType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.checkout.html">hcap<span class='break'> </span>.<span class='break'> </span>checkout</a></li>
|
|
|
|
<li><a href="../symbols/hcap.externalinput.html">hcap<span class='break'> </span>.<span class='break'> </span>externalinput</a></li>
|
|
|
|
<li><a href="../symbols/hcap.externalinput.ExternalInputType.html">hcap<span class='break'> </span>.<span class='break'> </span>externalinput<span class='break'> </span>.<span class='break'> </span>ExternalInputType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.file.html">hcap<span class='break'> </span>.<span class='break'> </span>file</a></li>
|
|
|
|
<li><a href="../symbols/hcap.iot.html">hcap<span class='break'> </span>.<span class='break'> </span>iot</a></li>
|
|
|
|
<li><a href="../symbols/hcap.key.html">hcap<span class='break'> </span>.<span class='break'> </span>key</a></li>
|
|
|
|
<li><a href="../symbols/hcap.key.Code.html">hcap<span class='break'> </span>.<span class='break'> </span>key<span class='break'> </span>.<span class='break'> </span>Code</a></li>
|
|
|
|
<li><a href="../symbols/hcap.Media.html">hcap<span class='break'> </span>.<span class='break'> </span>Media</a></li>
|
|
|
|
<li><a href="../symbols/hcap.Media.SubtitleType.html">hcap<span class='break'> </span>.<span class='break'> </span>Media<span class='break'> </span>.<span class='break'> </span>SubtitleType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.mode.html">hcap<span class='break'> </span>.<span class='break'> </span>mode</a></li>
|
|
|
|
<li><a href="../symbols/hcap.mouse.html">hcap<span class='break'> </span>.<span class='break'> </span>mouse</a></li>
|
|
|
|
<li><a href="../symbols/hcap.mpi.html">hcap<span class='break'> </span>.<span class='break'> </span>mpi</a></li>
|
|
|
|
<li><a href="../symbols/hcap.network.html">hcap<span class='break'> </span>.<span class='break'> </span>network</a></li>
|
|
|
|
<li><a href="../symbols/hcap.network.DhcpState.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>DhcpState</a></li>
|
|
|
|
<li><a href="../symbols/hcap.network.NetworkEventType.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>NetworkEventType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.network.NetworkMode.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>NetworkMode</a></li>
|
|
|
|
<li><a href="../symbols/hcap.network.WifiSecurityType.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>WifiSecurityType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.network.WirelessMode.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>WirelessMode</a></li>
|
|
|
|
<li><a href="../symbols/hcap.power.html">hcap<span class='break'> </span>.<span class='break'> </span>power</a></li>
|
|
|
|
<li><a href="../symbols/hcap.power.PowerMode.html">hcap<span class='break'> </span>.<span class='break'> </span>power<span class='break'> </span>.<span class='break'> </span>PowerMode</a></li>
|
|
|
|
<li><a href="../symbols/hcap.preloadedApplication.html">hcap<span class='break'> </span>.<span class='break'> </span>preloadedApplication</a></li>
|
|
|
|
<li><a href="../symbols/hcap.property.html">hcap<span class='break'> </span>.<span class='break'> </span>property</a></li>
|
|
|
|
<li><a href="../symbols/hcap.property.InstallerMenuItem.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>InstallerMenuItem</a></li>
|
|
|
|
<li><a href="../symbols/hcap.property.PictureMode.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>PictureMode</a></li>
|
|
|
|
<li><a href="../symbols/hcap.property.PicturePropertyKey.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>PicturePropertyKey</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rms.html">hcap<span class='break'> </span>.<span class='break'> </span>rms</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rs232c.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rs232c.BaudRate.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>BaudRate</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rs232c.DataBit.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>DataBit</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rs232c.FlowControl.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>FlowControl</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rs232c.Parity.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>Parity</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rs232c.StopBit.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>StopBit</a></li>
|
|
|
|
<li><a href="../symbols/hcap.security.html">hcap<span class='break'> </span>.<span class='break'> </span>security</a></li>
|
|
|
|
<li><a href="../symbols/hcap.socket.html">hcap<span class='break'> </span>.<span class='break'> </span>socket</a></li>
|
|
|
|
<li><a href="../symbols/hcap.speech.html">hcap<span class='break'> </span>.<span class='break'> </span>speech</a></li>
|
|
|
|
<li><a href="../symbols/hcap.speech.HostType.html">hcap<span class='break'> </span>.<span class='break'> </span>speech<span class='break'> </span>.<span class='break'> </span>HostType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.system.html">hcap<span class='break'> </span>.<span class='break'> </span>system</a></li>
|
|
|
|
<li><a href="../symbols/hcap.system.SoundOutputType.html">hcap<span class='break'> </span>.<span class='break'> </span>system<span class='break'> </span>.<span class='break'> </span>SoundOutputType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.time.html">hcap<span class='break'> </span>.<span class='break'> </span>time</a></li>
|
|
|
|
<li><a href="../symbols/hcap.video.html">hcap<span class='break'> </span>.<span class='break'> </span>video</a></li>
|
|
|
|
<li><a href="../symbols/hcap.volume.html">hcap<span class='break'> </span>.<span class='break'> </span>volume</a></li>
|
|
|
|
<li><a href="../symbols/hcap.webrtc.html">hcap<span class='break'> </span>.<span class='break'> </span>webrtc</a></li>
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
<div class="fineprint" style="clear:both">
|
|
<footer>
|
|
|
|
Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
|
|
Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
|
|
Generated on:
|
|
<time datetime='2021-8-13' pubdate>2021-8-13 18:29</time>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="index indexStatic"></div>
|
|
|
|
<div class="content">
|
|
<div class="innerContent">
|
|
<article>
|
|
<header>
|
|
<h1 class="classTitle">
|
|
|
|
Namespace <span>hcap.iot</span>
|
|
</h1>
|
|
|
|
<div class="intro">
|
|
<p class="description summary">
|
|
hcap.iot
|
|
</p>
|
|
|
|
|
|
<ul class="summary">
|
|
|
|
|
|
|
|
<li>Defined in: <a href="../symbols/src/js_hcap-1.24.6.5901.js.html">hcap-1.24.6.5901.js</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
</header>
|
|
|
|
|
|
<section>
|
|
<div class="props">
|
|
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class hcap.iot.">
|
|
<caption class="sectionTitle">Namespace Summary</caption>
|
|
<thead>
|
|
<tr>
|
|
<th scope="col">Constructor Attributes</th>
|
|
<th scope="col">Constructor Name and Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription" >
|
|
<div class="fixedFont">
|
|
<b><a href="../symbols/hcap.iot.html#constructor">hcap.iot</a></b>
|
|
</div>
|
|
<div class="description"></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
|
|
|
|
|
|
<!--
|
|
#### METHODS SUMMARY
|
|
-->
|
|
|
|
<section>
|
|
|
|
|
|
<div class="props">
|
|
<h2 class="sectionTitle">Method Summary</h2>
|
|
|
|
|
|
<nav>
|
|
<table class="summaryTable" id="MethodsList" cellspacing="0" summary="A summary of the methods documented in the class hcap.iot.">
|
|
<thead>
|
|
<tr>
|
|
<th scope="col">Method Attributes</th>
|
|
<th scope="col">Method Name and Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr
|
|
class='item0'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.iot.<b><a href="../symbols/hcap.iot.html#.getBindingIdList">getBindingIdList</a></b>(param)
|
|
</div>
|
|
<div class="description">Gets the binding ID list.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item1'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.iot.<b><a href="../symbols/hcap.iot.html#.getBridgeStatus">getBridgeStatus</a></b>(param)
|
|
</div>
|
|
<div class="description">Gets the bridge status.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item2'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.iot.<b><a href="../symbols/hcap.iot.html#.getFrameworkStatus">getFrameworkStatus</a></b>(param)
|
|
</div>
|
|
<div class="description">Gets the IoT framework status.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item3'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.iot.<b><a href="../symbols/hcap.iot.html#.getThingList">getThingList</a></b>(param)
|
|
</div>
|
|
<div class="description">Gets cached information for registered things.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item4'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.iot.<b><a href="../symbols/hcap.iot.html#.getVersions">getVersions</a></b>(param)
|
|
</div>
|
|
<div class="description">Get versions of hcapmw, iotservice, core and bindings.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item5'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.iot.<b><a href="../symbols/hcap.iot.html#.requestFactoryReset">requestFactoryReset</a></b>(param)
|
|
</div>
|
|
<div class="description">Request to do factory reset for core DB and binding DBs.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item6'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.iot.<b><a href="../symbols/hcap.iot.html#.requestRegisterThing">requestRegisterThing</a></b>(param)
|
|
</div>
|
|
<div class="description">Requests registration for a discovered thing.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item7'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.iot.<b><a href="../symbols/hcap.iot.html#.requestRejectThing">requestRejectThing</a></b>(param)
|
|
</div>
|
|
<div class="description">Requests a reject to register a discovered thing.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item8'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.iot.<b><a href="../symbols/hcap.iot.html#.requestSetBridgeStatus">requestSetBridgeStatus</a></b>(param)
|
|
</div>
|
|
<div class="description">Requests to set the bridge status.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item9'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.iot.<b><a href="../symbols/hcap.iot.html#.requestSetComponent">requestSetComponent</a></b>(param)
|
|
</div>
|
|
<div class="description">Requests to set the component value.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item10'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.iot.<b><a href="../symbols/hcap.iot.html#.requestSynchronizeThing">requestSynchronizeThing</a></b>(param)
|
|
</div>
|
|
<div class="description">Requests to synchronize components values of an IoT thing between components values in TV's cache and them in the thing.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item11'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.iot.<b><a href="../symbols/hcap.iot.html#.requestUnregisterThing">requestUnregisterThing</a></b>(param)
|
|
</div>
|
|
<div class="description">Requests to unregister a thing.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item12'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.iot.<b><a href="../symbols/hcap.iot.html#.setThingNickname">setThingNickname</a></b>(param)
|
|
</div>
|
|
<div class="description">Set the nickname of a thing.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
</nav>
|
|
|
|
|
|
|
|
</div>
|
|
</section>
|
|
|
|
|
|
<!--
|
|
#### EVENTS SUMMARY
|
|
-->
|
|
|
|
<!--
|
|
#### CONSTRUCTOR DETAILS
|
|
-->
|
|
|
|
<section>
|
|
<div class="details props">
|
|
<div class="innerProps">
|
|
<h2 class="sectionTitle" id="constructor">
|
|
Namespace Detail
|
|
</h2>
|
|
|
|
<div class="fixedFont">
|
|
<b>hcap.iot</b>
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<!--
|
|
#### FIELD DETAILS
|
|
-->
|
|
|
|
<!--
|
|
#### METHOD DETAILS
|
|
-->
|
|
|
|
<section>
|
|
<div class="details props">
|
|
<div class="innerProps">
|
|
<h2 class="sectionTitle">
|
|
Method Detail
|
|
</h2>
|
|
|
|
<ul class="methodDetail" id="MethodDetail">
|
|
|
|
|
|
<li
|
|
class='item0'
|
|
>
|
|
<div class="fixedFont heading" id=".getBindingIdList">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.iot.</span><b>getBindingIdList</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Gets the binding ID list.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.iot.getBindingIdList({
|
|
"onSuccess": function(s) {
|
|
console.log("getBindingIdList onSuccess : bindingIdList = " + JSON.stringify(s.bindingIdList));
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("getBindingIdList onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function (s) {
|
|
// {Array} s.bindingIdList - binding ID list when returnValue is true.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.22.2</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="_global_.html#event:iot_binding_ready">{Event} iot_binding_ready</a><br>
|
|
<a href="_global_.html#event:iot_thing_discovered">{Event} iot_thing_discovered</a><br>
|
|
<a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a><br>
|
|
<a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a><br>
|
|
<a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a><br>
|
|
<a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a><br>
|
|
<a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a><br>
|
|
<a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a><br>
|
|
<a href="_global_.html#event:iot_framework_status_changed">{Event} iot_framework_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a><br>
|
|
<a href="hcap.iot.html#.requestSetBridgeStatus">hcap.iot.requestSetBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.getBridgeStatus">hcap.iot.getBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestRegisterThing">hcap.iot.requestRegisterThing()</a><br>
|
|
<a href="hcap.iot.html#.requestRejectThing">hcap.iot.requestRejectThing()</a><br>
|
|
<a href="hcap.iot.html#.getThingList">hcap.iot.getThingList()</a><br>
|
|
<a href="hcap.iot.html#.requestSetComponent">hcap.iot.requestSetComponent()</a><br>
|
|
<a href="hcap.iot.html#.requestUnregisterThing">hcap.iot.requestUnregisterThing()</a><br>
|
|
<a href="hcap.iot.html#.setThingNickname">hcap.iot.setThingNickname()</a><br>
|
|
<a href="hcap.iot.html#.requestSynchronizeThing">hcap.iot.requestSynchronizeThing()</a><br>
|
|
<a href="hcap.iot.html#.getFrameworkStatus">hcap.iot.getFrameworkStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestFactoryReset">hcap.iot.requestFactoryReset()</a><br>
|
|
<a href="hcap.iot.html#.getVersions">hcap.iot.getVersions()</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item1'
|
|
>
|
|
<div class="fixedFont heading" id=".getBridgeStatus">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.iot.</span><b>getBridgeStatus</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Gets the bridge status.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.iot.getBridgeStatus({
|
|
"bridgeUid": "Zigbee:ZHA",
|
|
"onSuccess": function(s) {
|
|
console.log("getBridgeStatus onSuccess : status = " + s.status);
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("getBridgeStatus onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{String} param.bridgeUid [Required] - bridge UID.<br>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function (param) {
|
|
// {String} param.status - "scan" for scan status, "normal" for normal (non-scan) status.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.22.2</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="_global_.html#event:iot_binding_ready">{Event} iot_binding_ready</a><br>
|
|
<a href="_global_.html#event:iot_thing_discovered">{Event} iot_thing_discovered</a><br>
|
|
<a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a><br>
|
|
<a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a><br>
|
|
<a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a><br>
|
|
<a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a><br>
|
|
<a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a><br>
|
|
<a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a><br>
|
|
<a href="_global_.html#event:iot_framework_status_changed">{Event} iot_framework_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a><br>
|
|
<a href="hcap.iot.html#.requestSetBridgeStatus">hcap.iot.requestSetBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestRegisterThing">hcap.iot.requestRegisterThing()</a><br>
|
|
<a href="hcap.iot.html#.requestRejectThing">hcap.iot.requestRejectThing()</a><br>
|
|
<a href="hcap.iot.html#.getThingList">hcap.iot.getThingList()</a><br>
|
|
<a href="hcap.iot.html#.getBindingIdList">hcap.iot.getBindingIdList()</a><br>
|
|
<a href="hcap.iot.html#.requestSetComponent">hcap.iot.requestSetComponent()</a><br>
|
|
<a href="hcap.iot.html#.requestUnregisterThing">hcap.iot.requestUnregisterThing()</a><br>
|
|
<a href="hcap.iot.html#.setThingNickname">hcap.iot.setThingNickname()</a><br>
|
|
<a href="hcap.iot.html#.requestSynchronizeThing">hcap.iot.requestSynchronizeThing()</a><br>
|
|
<a href="hcap.iot.html#.getFrameworkStatus">hcap.iot.getFrameworkStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestFactoryReset">hcap.iot.requestFactoryReset()</a><br>
|
|
<a href="hcap.iot.html#.getVersions">hcap.iot.getVersions()</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item2'
|
|
>
|
|
<div class="fixedFont heading" id=".getFrameworkStatus">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.iot.</span><b>getFrameworkStatus</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Gets the IoT framework status.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.iot.getFrameworkStatus({
|
|
"onSuccess": function(s) {
|
|
console.log("getFrameworkStatus onSuccess : status = " + s.status);
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("getFrameworkStatus onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function (param) {
|
|
// {String} param.status - "off" : framework is off, "initializing" : framework is initializing, "ready" : framework is ready.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.22.2</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="_global_.html#event:iot_binding_ready">{Event} iot_binding_ready</a><br>
|
|
<a href="_global_.html#event:iot_thing_discovered">{Event} iot_thing_discovered</a><br>
|
|
<a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a><br>
|
|
<a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a><br>
|
|
<a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a><br>
|
|
<a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a><br>
|
|
<a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a><br>
|
|
<a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a><br>
|
|
<a href="_global_.html#event:iot_framework_status_changed">{Event} iot_framework_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a><br>
|
|
<a href="hcap.iot.html#.requestSetBridgeStatus">hcap.iot.requestSetBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.getBridgeStatus">hcap.iot.getBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestRegisterThing">hcap.iot.requestRegisterThing()</a><br>
|
|
<a href="hcap.iot.html#.requestRejectThing">hcap.iot.requestRejectThing()</a><br>
|
|
<a href="hcap.iot.html#.getThingList">hcap.iot.getThingList()</a><br>
|
|
<a href="hcap.iot.html#.getBindingIdList">hcap.iot.getBindingIdList()</a><br>
|
|
<a href="hcap.iot.html#.requestSetComponent">hcap.iot.requestSetComponent()</a><br>
|
|
<a href="hcap.iot.html#.requestUnregisterThing">hcap.iot.requestUnregisterThing()</a><br>
|
|
<a href="hcap.iot.html#.setThingNickname">hcap.iot.setThingNickname()</a><br>
|
|
<a href="hcap.iot.html#.requestSynchronizeThing">hcap.iot.requestSynchronizeThing()</a><br>
|
|
<a href="hcap.iot.html#.requestFactoryReset">hcap.iot.requestFactoryReset()</a><br>
|
|
<a href="hcap.iot.html#.getVersions">hcap.iot.getVersions()</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item3'
|
|
>
|
|
<div class="fixedFont heading" id=".getThingList">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.iot.</span><b>getThingList</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Gets cached information for registered things.<br>
|
|
Each parameter works as a filter for result things list.<br>
|
|
If several parameters are given, only the highest priority parameter will be effective. Priorities among parameters are (HIGH) > <i>thingUidList</i> > <i>thingTypeId</i> > (LOW).<br>
|
|
If no parameter is given, it's same as no filter, therefore all things list will be returned.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.iot.getThingList({
|
|
"onSuccess": function(s) {
|
|
console.log("getThingList onSuccess : valueType of the first component of the first thing = " + s.thingList[0].thingComponentList[0].componentValue.valueType);
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("getThingList onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{Array} param.thingUidList [Required] - thing UID list as an array of a string thingUids like [|thingUid-0|, |thingUid-1|, ..., |thingUid-n|] while |thingUid-n| is a string of thing UID.<br>
|
|
<li>{String} param.thingType [Optional] - |ThingType|, thing type. <b><i>ThingBridge</i></b> for bridges. <b><i>ThingDiscovered</i></b> for discovered things.<br>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function (s) {
|
|
// {Array} s.thingList - information for things as a type of json array as of [|thing-0|, |thing-1|, ..., |thing-n|]
|
|
// |thing-n| - json object for a thing
|
|
// {
|
|
// "bindingId": |string|, // binding ID
|
|
// "thingUid" : |string|, //thing UID
|
|
// "thingId" : |string|, // thing ID
|
|
// "thingType" : |ThingType|, //thing type
|
|
// "thingMetaData" : |ThingMetaData|, // thing meta data
|
|
// "thingComponentList": [|thingComponentList-0|, |thingComponentList-1|, ..., |thingComponentList-n|], // component list of the thing
|
|
// }
|
|
// |thingComponentList-n| - json object for a component
|
|
// {
|
|
// "parentThingUid": |string|, // parent thing UID of the component
|
|
// "componentType": |string|, // component type
|
|
// "componentId": |string|, // component ID
|
|
// "componentValueType": |string|, // component value type
|
|
// "componentValue": |ComponentValue|, // component value
|
|
// "componentGettable": |boolean|, // true:component is gettable, false:component is not gettable
|
|
// "componentSettable": |boolean|, // true:component is settable, false:component is not settable
|
|
// }
|
|
// |ComponentValue| - json object for a component value
|
|
// {
|
|
// "valueType": |string|, // "Unknown", "String", "Boolean", "Variables", "Double", "Float", "Int8", "Int16", "Int32", "Int64", "UInt8", "UInt16", "UInt32", "UInt64"
|
|
// "value": |string|, // value
|
|
// "additionalValue": |string|, //custom additional value as a string
|
|
// }
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.22.2</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="_global_.html#event:iot_binding_ready">{Event} iot_binding_ready</a><br>
|
|
<a href="_global_.html#event:iot_thing_discovered">{Event} iot_thing_discovered</a><br>
|
|
<a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a><br>
|
|
<a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a><br>
|
|
<a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a><br>
|
|
<a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a><br>
|
|
<a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a><br>
|
|
<a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a><br>
|
|
<a href="_global_.html#event:iot_framework_status_changed">{Event} iot_framework_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a><br>
|
|
<a href="hcap.iot.html#.requestSetBridgeStatus">hcap.iot.requestSetBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.getBridgeStatus">hcap.iot.getBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestRegisterThing">hcap.iot.requestRegisterThing()</a><br>
|
|
<a href="hcap.iot.html#.requestRejectThing">hcap.iot.requestRejectThing()</a><br>
|
|
<a href="hcap.iot.html#.getBindingIdList">hcap.iot.getBindingIdList()</a><br>
|
|
<a href="hcap.iot.html#.requestSetComponent">hcap.iot.requestSetComponent()</a><br>
|
|
<a href="hcap.iot.html#.requestUnregisterThing">hcap.iot.requestUnregisterThing()</a><br>
|
|
<a href="hcap.iot.html#.setThingNickname">hcap.iot.setThingNickname()</a><br>
|
|
<a href="hcap.iot.html#.requestSynchronizeThing">hcap.iot.requestSynchronizeThing()</a><br>
|
|
<a href="hcap.iot.html#.getFrameworkStatus">hcap.iot.getFrameworkStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestFactoryReset">hcap.iot.requestFactoryReset()</a><br>
|
|
<a href="hcap.iot.html#.getVersions">hcap.iot.getVersions()</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item4'
|
|
>
|
|
<div class="fixedFont heading" id=".getVersions">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.iot.</span><b>getVersions</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Get versions of hcapmw, iotservice, core and bindings.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.iot.getVersions({
|
|
"onSuccess": function(s) {
|
|
console.log("getVersions onSuccess : versions = " + JSON.stringify(s.versions));
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("getVersions onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function (s) {
|
|
// {Object} s.versions - versions of JSON foramt when returnValue is true. If no binding is ready, "bindings" doesn't exist.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.22.2</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="_global_.html#event:iot_binding_ready">{Event} iot_binding_ready</a><br>
|
|
<a href="_global_.html#event:iot_thing_discovered">{Event} iot_thing_discovered</a><br>
|
|
<a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a><br>
|
|
<a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a><br>
|
|
<a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a><br>
|
|
<a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a><br>
|
|
<a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a><br>
|
|
<a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a><br>
|
|
<a href="_global_.html#event:iot_framework_status_changed">{Event} iot_framework_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a><br>
|
|
<a href="hcap.iot.html#.requestSetBridgeStatus">hcap.iot.requestSetBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.getBridgeStatus">hcap.iot.getBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestRegisterThing">hcap.iot.requestRegisterThing()</a><br>
|
|
<a href="hcap.iot.html#.requestRejectThing">hcap.iot.requestRejectThing()</a><br>
|
|
<a href="hcap.iot.html#.getThingList">hcap.iot.getThingList()</a><br>
|
|
<a href="hcap.iot.html#.getBindingIdList">hcap.iot.getBindingIdList()</a><br>
|
|
<a href="hcap.iot.html#.requestSetComponent">hcap.iot.requestSetComponent()</a><br>
|
|
<a href="hcap.iot.html#.requestUnregisterThing">hcap.iot.requestUnregisterThing()</a><br>
|
|
<a href="hcap.iot.html#.setThingNickname">hcap.iot.setThingNickname()</a><br>
|
|
<a href="hcap.iot.html#.requestSynchronizeThing">hcap.iot.requestSynchronizeThing()</a><br>
|
|
<a href="hcap.iot.html#.getFrameworkStatus">hcap.iot.getFrameworkStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestFactoryReset">hcap.iot.requestFactoryReset()</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item5'
|
|
>
|
|
<div class="fixedFont heading" id=".requestFactoryReset">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.iot.</span><b>requestFactoryReset</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Request to do factory reset for core DB and binding DBs.<br>
|
|
If factory reset is successful, <a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a> will be delivered.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.iot.requestFactoryReset({
|
|
"onSuccess": function(s) {
|
|
console.log("requestFactoryReset onSuccess");
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("requestFactoryReset onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{Array} param.bindingIdList [Required] - binding ID list to do factory reset.<br> If bindingIdList is undefined, core and all bindings will remove DB file.<br>
|
|
If bindingIdList is defined, the bindings in bindingIdList will remove DB files, and core will remove bindings in binidngIdList and their information in core DB but core will not remove core DB file.<br>
|
|
For core or bindings to delete its DB file, its factory reset result will be included in factoryResetResultList of IoT event <a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received<br>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function (param) {
|
|
// No parameter.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.22.2</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="_global_.html#event:iot_binding_ready">{Event} iot_binding_ready</a><br>
|
|
<a href="_global_.html#event:iot_thing_discovered">{Event} iot_thing_discovered</a><br>
|
|
<a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a><br>
|
|
<a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a><br>
|
|
<a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a><br>
|
|
<a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a><br>
|
|
<a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a><br>
|
|
<a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a><br>
|
|
<a href="_global_.html#event:iot_framework_status_changed">{Event} iot_framework_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a><br>
|
|
<a href="hcap.iot.html#.requestSetBridgeStatus">hcap.iot.requestSetBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.getBridgeStatus">hcap.iot.getBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestRegisterThing">hcap.iot.requestRegisterThing()</a><br>
|
|
<a href="hcap.iot.html#.requestRejectThing">hcap.iot.requestRejectThing()</a><br>
|
|
<a href="hcap.iot.html#.getThingList">hcap.iot.getThingList()</a><br>
|
|
<a href="hcap.iot.html#.getBindingIdList">hcap.iot.getBindingIdList()</a><br>
|
|
<a href="hcap.iot.html#.requestSetComponent">hcap.iot.requestSetComponent()</a><br>
|
|
<a href="hcap.iot.html#.requestUnregisterThing">hcap.iot.requestUnregisterThing()</a><br>
|
|
<a href="hcap.iot.html#.setThingNickname">hcap.iot.setThingNickname()</a><br>
|
|
<a href="hcap.iot.html#.requestSynchronizeThing">hcap.iot.requestSynchronizeThing()</a><br>
|
|
<a href="hcap.iot.html#.getVersions">hcap.iot.getVersions()</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item6'
|
|
>
|
|
<div class="fixedFont heading" id=".requestRegisterThing">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.iot.</span><b>requestRegisterThing</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Requests registration for a discovered thing.<br>
|
|
If the discovered thing is registered, <a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a> will be delivered and <a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a> may also be delivered subsequently.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">document.addEventListener(
|
|
"iot_thing_discovered",
|
|
function (param) {
|
|
// {String} param.bindingId - binding ID.
|
|
// {String} param.thingUid : thing UID.
|
|
console.log(
|
|
"Event 'iot_thing_discovered' is received.\n" +
|
|
"bindingId = " + param.bindingId + "\n" +
|
|
"thingUid = " + param.thingUid
|
|
);
|
|
hcap.iot.requestRegisterThing({
|
|
"thingUid": param.thingUid,
|
|
"onSuccess": function() {
|
|
console.log("requestRegisterThing onSuccess");
|
|
},
|
|
"onFailure": function(f) {
|
|
console.log("requestRegisterThing onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});
|
|
},
|
|
false
|
|
);</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{String} param.thingUid [Required] - UID of the discovered thing to register.<br>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function () {
|
|
// No Parameter.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.22.2</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="_global_.html#event:iot_binding_ready">{Event} iot_binding_ready</a><br>
|
|
<a href="_global_.html#event:iot_thing_discovered">{Event} iot_thing_discovered</a><br>
|
|
<a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a><br>
|
|
<a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a><br>
|
|
<a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a><br>
|
|
<a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a><br>
|
|
<a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a><br>
|
|
<a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a><br>
|
|
<a href="_global_.html#event:iot_framework_status_changed">{Event} iot_framework_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a><br>
|
|
<a href="hcap.iot.html#.requestSetBridgeStatus">hcap.iot.requestSetBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.getBridgeStatus">hcap.iot.getBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestRejectThing">hcap.iot.requestRejectThing()</a><br>
|
|
<a href="hcap.iot.html#.getThingList">hcap.iot.getThingList()</a><br>
|
|
<a href="hcap.iot.html#.getBindingIdList">hcap.iot.getBindingIdList()</a><br>
|
|
<a href="hcap.iot.html#.requestSetComponent">hcap.iot.requestSetComponent()</a><br>
|
|
<a href="hcap.iot.html#.requestUnregisterThing">hcap.iot.requestUnregisterThing()</a><br>
|
|
<a href="hcap.iot.html#.setThingNickname">hcap.iot.setThingNickname()</a><br>
|
|
<a href="hcap.iot.html#.requestSynchronizeThing">hcap.iot.requestSynchronizeThing()</a><br>
|
|
<a href="hcap.iot.html#.getFrameworkStatus">hcap.iot.getFrameworkStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestFactoryReset">hcap.iot.requestFactoryReset()</a><br>
|
|
<a href="hcap.iot.html#.getVersions">hcap.iot.getVersions()</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item7'
|
|
>
|
|
<div class="fixedFont heading" id=".requestRejectThing">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.iot.</span><b>requestRejectThing</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Requests a reject to register a discovered thing.<br>
|
|
If the discovered thing is rejected to register, <a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a> will be delivered.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.iot.requestRejectThing({
|
|
"thingUid": "Zigbee:01EC789805006F0D00",
|
|
"onSuccess": function() {
|
|
console.log("requestRejectThing onSuccess");
|
|
},
|
|
"onFailure": function(f) {
|
|
console.log("requestRejectThing onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{String} param.thingUid [Required] - UID of the discovered thing to reject.<br>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function () {
|
|
// No Parameter.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.22.2</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="_global_.html#event:iot_binding_ready">{Event} iot_binding_ready</a><br>
|
|
<a href="_global_.html#event:iot_thing_discovered">{Event} iot_thing_discovered</a><br>
|
|
<a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a><br>
|
|
<a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a><br>
|
|
<a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a><br>
|
|
<a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a><br>
|
|
<a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a><br>
|
|
<a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a><br>
|
|
<a href="_global_.html#event:iot_framework_status_changed">{Event} iot_framework_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a><br>
|
|
<a href="hcap.iot.html#.requestSetBridgeStatus">hcap.iot.requestSetBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.getBridgeStatus">hcap.iot.getBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestRegisterThing">hcap.iot.requestRegisterThing()</a><br>
|
|
<a href="hcap.iot.html#.getThingList">hcap.iot.getThingList()</a><br>
|
|
<a href="hcap.iot.html#.getBindingIdList">hcap.iot.getBindingIdList()</a><br>
|
|
<a href="hcap.iot.html#.requestSetComponent">hcap.iot.requestSetComponent()</a><br>
|
|
<a href="hcap.iot.html#.requestUnregisterThing">hcap.iot.requestUnregisterThing()</a><br>
|
|
<a href="hcap.iot.html#.setThingNickname">hcap.iot.setThingNickname()</a><br>
|
|
<a href="hcap.iot.html#.requestSynchronizeThing">hcap.iot.requestSynchronizeThing()</a><br>
|
|
<a href="hcap.iot.html#.getFrameworkStatus">hcap.iot.getFrameworkStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestFactoryReset">hcap.iot.requestFactoryReset()</a><br>
|
|
<a href="hcap.iot.html#.getVersions">hcap.iot.getVersions()</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item8'
|
|
>
|
|
<div class="fixedFont heading" id=".requestSetBridgeStatus">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.iot.</span><b>requestSetBridgeStatus</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Requests to set the bridge status.<br>
|
|
If the bridge status is changed, <a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a> will be delivered.<br>
|
|
In "scan" mode, a bridge can terminate the "scan" mode and change to "normal" mode by the timeout (the timeout is different binding by binding).<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.iot.getThingList({
|
|
"thingType": "ThingBridge",
|
|
"onSuccess": function(s) {
|
|
console.log("getThingList onSuccess");
|
|
hcap.iot.requestSetBridgeStatus({
|
|
"bridgeUid": s.thingList[0].thingUid,
|
|
"status": "scan",
|
|
"onSuccess": function() {
|
|
console.log("requestSetBridgeStatus onSuccess");
|
|
},
|
|
"onFailure": function(sf) {
|
|
console.log("requestSetBridgeStatus onFailure : errorMessage = " + sf.errorMessage);
|
|
}
|
|
});
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("getThingList onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{String} param.bridgeUid [Required] - bridge UID.<br>
|
|
<li>{String} param.status [Required] - "scan" for scan status, "normal" for normal (non-scan) status.<br>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function. Request for the same status returns <i>onSuccess</i> and it has no effect.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function () {
|
|
// No Parameter.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.22.2</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="_global_.html#event:iot_binding_ready">{Event} iot_binding_ready</a><br>
|
|
<a href="_global_.html#event:iot_thing_discovered">{Event} iot_thing_discovered</a><br>
|
|
<a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a><br>
|
|
<a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a><br>
|
|
<a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a><br>
|
|
<a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a><br>
|
|
<a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a><br>
|
|
<a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a><br>
|
|
<a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a><br>
|
|
<a href="hcap.iot.html#.getBridgeStatus">hcap.iot.getBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestRegisterThing">hcap.iot.requestRegisterThing()</a><br>
|
|
<a href="hcap.iot.html#.requestRejectThing">hcap.iot.requestRejectThing()</a><br>
|
|
<a href="hcap.iot.html#.getThingList">hcap.iot.getThingList()</a><br>
|
|
<a href="hcap.iot.html#.getBindingIdList">hcap.iot.getBindingIdList()</a><br>
|
|
<a href="hcap.iot.html#.requestSetComponent">hcap.iot.requestSetComponent()</a><br>
|
|
<a href="hcap.iot.html#.requestUnregisterThing">hcap.iot.requestUnregisterThing()</a><br>
|
|
<a href="hcap.iot.html#.setThingNickname">hcap.iot.setThingNickname()</a><br>
|
|
<a href="hcap.iot.html#.requestSynchronizeThing">hcap.iot.requestSynchronizeThing()</a><br>
|
|
<a href="hcap.iot.html#.getFrameworkStatus">hcap.iot.getFrameworkStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestFactoryReset">hcap.iot.requestFactoryReset()</a><br>
|
|
<a href="hcap.iot.html#.getVersions">hcap.iot.getVersions()</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item9'
|
|
>
|
|
<div class="fixedFont heading" id=".requestSetComponent">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.iot.</span><b>requestSetComponent</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Requests to set the component value.<br>
|
|
If this call is succeeded or failed, <a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a> will be delivered.<br>
|
|
If the component value is changed, <a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a> will be delivered.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.iot.requestSetComponent({
|
|
"thingUid": "Zigbee:01EC789805006F0D00",
|
|
"componentId": "Dimming",
|
|
"componentValue": {
|
|
"additionalVlaue":"",
|
|
"valueType": "Double",
|
|
"value": "60"
|
|
},
|
|
"callId": "7",
|
|
"onSuccess": function() {
|
|
console.log("requestSetComponent onSuccess");
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("requestSetComponent onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{String} param.thingUid [Required] - thing UID.<br>
|
|
<li>{String} param.componentId [Required] - component ID.<br>
|
|
<li>{Object} param.componentValue [Required] - |ComponentValue|. component value to set.<br>
|
|
<pre class="code prettyprint">
|
|
// {Object} |ComponentValue| - json object for a variable
|
|
// {
|
|
// "valueType": |string|, // "Unknown", "String", "Boolean", "Variables", "Double", "Float", "Int8", "Int16", "Int32", "Int64", "UInt8", "UInt16", "UInt32", "UInt64"
|
|
// "value": |string|, // value
|
|
// "additionalValue": |string|, //custom additional value as a string
|
|
// }</pre>
|
|
<li>{String} param.callId [Required] - callId which will be delivered for the result identification of this call via <a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a>.<br>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function () {
|
|
// No Parameter.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.22.2</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="_global_.html#event:iot_binding_ready">{Event} iot_binding_ready</a><br>
|
|
<a href="_global_.html#event:iot_thing_discovered">{Event} iot_thing_discovered</a><br>
|
|
<a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a><br>
|
|
<a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a><br>
|
|
<a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a><br>
|
|
<a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a><br>
|
|
<a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a><br>
|
|
<a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a><br>
|
|
<a href="_global_.html#event:iot_framework_status_changed">{Event} iot_framework_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a><br>
|
|
<a href="hcap.iot.html#.requestSetBridgeStatus">hcap.iot.requestSetBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.getBridgeStatus">hcap.iot.getBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestRegisterThing">hcap.iot.requestRegisterThing()</a><br>
|
|
<a href="hcap.iot.html#.requestRejectThing">hcap.iot.requestRejectThing()</a><br>
|
|
<a href="hcap.iot.html#.getThingList">hcap.iot.getThingList()</a><br>
|
|
<a href="hcap.iot.html#.getBindingIdList">hcap.iot.getBindingIdList()</a><br>
|
|
<a href="hcap.iot.html#.requestUnregisterThing">hcap.iot.requestUnregisterThing()</a><br>
|
|
<a href="hcap.iot.html#.setThingNickname">hcap.iot.setThingNickname()</a><br>
|
|
<a href="hcap.iot.html#.requestSynchronizeThing">hcap.iot.requestSynchronizeThing()</a><br>
|
|
<a href="hcap.iot.html#.getFrameworkStatus">hcap.iot.getFrameworkStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestFactoryReset">hcap.iot.requestFactoryReset()</a><br>
|
|
<a href="hcap.iot.html#.getVersions">hcap.iot.getVersions()</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item10'
|
|
>
|
|
<div class="fixedFont heading" id=".requestSynchronizeThing">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.iot.</span><b>requestSynchronizeThing</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Requests to synchronize components values of an IoT thing between components values in TV's cache and them in the thing.<br>
|
|
This request is a trigger to update components between TV and the thing.<br>
|
|
Therefore if the thing is not reached by the reason like thing's sleep, it will be failed to synchronize components.<br>
|
|
If the request for a component update is reached to the thing, <a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a> will be delivered.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.iot.requestSynchronizeThing({
|
|
"thingUid": "Zigbee:01EC789805006F0D00",
|
|
"onSuccess": function() {
|
|
console.log("requestSynchronizeThing onSuccess");
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("requestSynchronizeThing onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{String} param.thingUid [Required] - thing UID to synchronize.<br>
|
|
<li>{String} param.componentId [Optional] - component ID to synchronize. If <i>componentId</i> is not defined, all components of the thing will be requested to synchronize.<br>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function () {
|
|
// No Parameter.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.22.2</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="_global_.html#event:iot_binding_ready">{Event} iot_binding_ready</a><br>
|
|
<a href="_global_.html#event:iot_thing_discovered">{Event} iot_thing_discovered</a><br>
|
|
<a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a><br>
|
|
<a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a><br>
|
|
<a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a><br>
|
|
<a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a><br>
|
|
<a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a><br>
|
|
<a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a><br>
|
|
<a href="_global_.html#event:iot_framework_status_changed">{Event} iot_framework_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a><br>
|
|
<a href="hcap.iot.html#.requestSetBridgeStatus">hcap.iot.requestSetBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.getBridgeStatus">hcap.iot.getBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestRegisterThing">hcap.iot.requestRegisterThing()</a><br>
|
|
<a href="hcap.iot.html#.requestRejectThing">hcap.iot.requestRejectThing()</a><br>
|
|
<a href="hcap.iot.html#.getThingList">hcap.iot.getThingList()</a><br>
|
|
<a href="hcap.iot.html#.getBindingIdList">hcap.iot.getBindingIdList()</a><br>
|
|
<a href="hcap.iot.html#.requestSetComponent">hcap.iot.requestSetComponent()</a><br>
|
|
<a href="hcap.iot.html#.requestUnregisterThing">hcap.iot.requestUnregisterThing()</a><br>
|
|
<a href="hcap.iot.html#.setThingNickname">hcap.iot.setThingNickname()</a><br>
|
|
<a href="hcap.iot.html#.getFrameworkStatus">hcap.iot.getFrameworkStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestFactoryReset">hcap.iot.requestFactoryReset()</a><br>
|
|
<a href="hcap.iot.html#.getVersions">hcap.iot.getVersions()</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item11'
|
|
>
|
|
<div class="fixedFont heading" id=".requestUnregisterThing">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.iot.</span><b>requestUnregisterThing</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Requests to unregister a thing.<br>
|
|
If a thing is unregistered, <a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a> will be delivered.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.iot.requestUnregisterThing({
|
|
"thingUid": "Zigbee:01EC789805006F0D00",
|
|
"onSuccess": function() {
|
|
console.log("requestUnregisterThing onSuccess");
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("requestUnregisterThing onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{String} param.thingUid [Required] - thing UID to unregister.<br>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function () {
|
|
// No Parameter.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.22.2</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="_global_.html#event:iot_binding_ready">{Event} iot_binding_ready</a><br>
|
|
<a href="_global_.html#event:iot_thing_discovered">{Event} iot_thing_discovered</a><br>
|
|
<a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a><br>
|
|
<a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a><br>
|
|
<a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a><br>
|
|
<a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a><br>
|
|
<a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a><br>
|
|
<a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a><br>
|
|
<a href="_global_.html#event:iot_framework_status_changed">{Event} iot_framework_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a><br>
|
|
<a href="hcap.iot.html#.requestSetBridgeStatus">hcap.iot.requestSetBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.getBridgeStatus">hcap.iot.getBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestRegisterThing">hcap.iot.requestRegisterThing()</a><br>
|
|
<a href="hcap.iot.html#.requestRejectThing">hcap.iot.requestRejectThing()</a><br>
|
|
<a href="hcap.iot.html#.getThingList">hcap.iot.getThingList()</a><br>
|
|
<a href="hcap.iot.html#.getBindingIdList">hcap.iot.getBindingIdList()</a><br>
|
|
<a href="hcap.iot.html#.requestSetComponent">hcap.iot.requestSetComponent()</a><br>
|
|
<a href="hcap.iot.html#.setThingNickname">hcap.iot.setThingNickname()</a><br>
|
|
<a href="hcap.iot.html#.requestSynchronizeThing">hcap.iot.requestSynchronizeThing()</a><br>
|
|
<a href="hcap.iot.html#.getFrameworkStatus">hcap.iot.getFrameworkStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestFactoryReset">hcap.iot.requestFactoryReset()</a><br>
|
|
<a href="hcap.iot.html#.getVersions">hcap.iot.getVersions()</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item12'
|
|
>
|
|
<div class="fixedFont heading" id=".setThingNickname">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.iot.</span><b>setThingNickname</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Set the nickname of a thing.<br>
|
|
The change of the nickname of a thing causes <a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a>.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.iot.setThingNickname({
|
|
"thingUid": "Zigbee:01EC789805006F0D00",
|
|
"nickname": "NewNickname",
|
|
"onSuccess": function() {
|
|
console.log("setThingNickname onSuccess");
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("setThingNickname onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{String} param.thingUid [Required] - thing UID to remove.<br>
|
|
<li>{String} param.nickname [Required] - nickname.<br>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function () {
|
|
// No Parameter.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.22.2</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="_global_.html#event:iot_binding_ready">{Event} iot_binding_ready</a><br>
|
|
<a href="_global_.html#event:iot_thing_discovered">{Event} iot_thing_discovered</a><br>
|
|
<a href="_global_.html#event:iot_bridge_status_changed">{Event} iot_bridge_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_thing_registered">{Event} iot_thing_registered</a><br>
|
|
<a href="_global_.html#event:iot_thing_rejected">{Event} iot_thing_rejected</a><br>
|
|
<a href="_global_.html#event:iot_component_reported">{Event} iot_component_reported</a><br>
|
|
<a href="_global_.html#event:iot_thing_unregistered">{Event} iot_thing_unregistered</a><br>
|
|
<a href="_global_.html#event:iot_thing_meta_data_changed">{Event} iot_thing_meta_data_changed</a><br>
|
|
<a href="_global_.html#event:iot_set_component_result_received">{Event} iot_set_component_result_received</a><br>
|
|
<a href="_global_.html#event:iot_framework_status_changed">{Event} iot_framework_status_changed</a><br>
|
|
<a href="_global_.html#event:iot_factory_reset_result_received">{Event} iot_factory_reset_result_received</a><br>
|
|
<a href="hcap.iot.html#.requestSetBridgeStatus">hcap.iot.requestSetBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.getBridgeStatus">hcap.iot.getBridgeStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestRegisterThing">hcap.iot.requestRegisterThing()</a><br>
|
|
<a href="hcap.iot.html#.requestRejectThing">hcap.iot.requestRejectThing()</a><br>
|
|
<a href="hcap.iot.html#.getThingList">hcap.iot.getThingList()</a><br>
|
|
<a href="hcap.iot.html#.getBindingIdList">hcap.iot.getBindingIdList()</a><br>
|
|
<a href="hcap.iot.html#.requestSetComponent">hcap.iot.requestSetComponent()</a><br>
|
|
<a href="hcap.iot.html#.requestUnregisterThing">hcap.iot.requestUnregisterThing()</a><br>
|
|
<a href="hcap.iot.html#.requestSynchronizeThing">hcap.iot.requestSynchronizeThing()</a><br>
|
|
<a href="hcap.iot.html#.getFrameworkStatus">hcap.iot.getFrameworkStatus()</a><br>
|
|
<a href="hcap.iot.html#.requestFactoryReset">hcap.iot.requestFactoryReset()</a><br>
|
|
<a href="hcap.iot.html#.getVersions">hcap.iot.getVersions()</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
|
|
<!--
|
|
#### EVENT DETAILS
|
|
-->
|
|
|
|
</article>
|
|
</div>
|
|
</div>
|
|
|
|
<script type="text/javascript">
|
|
wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660)
|
|
codeview.classFilter.Init()
|
|
</script>
|
|
<script src="../javascript/highlighter/prettify.js"></script>
|
|
<script>prettyPrint();</script>
|
|
</body>
|
|
</html>
|
|
|