_site/updateStatusHttp_en.html

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="">
<meta name="keywords" content=" ">
<title>Update Device Status | Jekyll theme for documentation</title>
<link rel="stylesheet" href="css/syntax.css">

<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
<link rel="stylesheet" href="css/modern-business.css">
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<link rel="stylesheet" href="css/customstyles.css">
<link rel="stylesheet" href="css/boxshadowproperties.css">
<!-- most color styles are extracted out to here -->
<link rel="stylesheet" href="css/theme-blue.css">

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
<script src="js/jquery.navgoco.min.js"></script>


<!-- Latest compiled and minified JavaScript -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<!-- Anchor.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
<script src="js/toc.js"></script>
<script src="js/customscripts.js"></script>

<link rel="shortcut icon" href="images/favicon.ico">

<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="alternate" type="application/rss+xml" title="" href="http://localhost:4000/feed.xml">

    <script>
        $(document).ready(function() {
            // Initialize navgoco with default options
            $("#mysidebar").navgoco({
                caretHtml: '',
                accordion: true,
                openClass: 'active', // open
                save: false, // leave false or nav highlighting doesn't work right
                cookie: {
                    name: 'navgoco',
                    expires: false,
                    path: '/'
                },
                slide: {
                    duration: 400,
                    easing: 'swing'
                }
            });

            $("#collapseAll").click(function(e) {
                e.preventDefault();
                $("#mysidebar").navgoco('toggle', false);
            });

            $("#expandAll").click(function(e) {
                e.preventDefault();
                $("#mysidebar").navgoco('toggle', true);
            });

        });

    </script>
    <script>
        $(function () {
            $('[data-toggle="tooltip"]').tooltip()
        })
    </script>
    <script>
        $(document).ready(function() {
            $("#tg-sb-link").click(function() {
                $("#tg-sb-sidebar").toggle();
                $("#tg-sb-content").toggleClass('col-md-9');
                $("#tg-sb-content").toggleClass('col-md-12');
                $("#tg-sb-icon").toggleClass('fa-toggle-on');
                $("#tg-sb-icon").toggleClass('fa-toggle-off');
            });
        });
    </script>
    

</head>
<body>
<!-- Navigation -->
<nav class="navbar navbar-inverse navbar-static-top">
    <div class="container topnavlinks">
        <div class="navbar-header">
            <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
            </button>
            <a class="fa fa-home fa-lg navbar-brand" href="index.html">&nbsp;<span class="projectTitle"> CoolKit Cloud Platform</span></a>
        </div>
        <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
            <ul class="nav navbar-nav navbar-right">
		<li style="line-height: 50px;">
		    <label><a href="index.html">中文</a></label>
		    <label><a href="platformOverview_en.html">English</a></label>
		</li>
                <li>
                    <!--start search-->
                    <div id="search-demo-container">
                        <input type="text" id="search-input" placeholder="search...">
                        <ul id="results-container"></ul>
                    </div>
                    <script src="js/jekyll-search.js" type="text/javascript"></script>
                    <script type="text/javascript">
                            SimpleJekyllSearch.init({
                                searchInput: document.getElementById('search-input'),
                                resultsContainer: document.getElementById('results-container'),
                                dataSource: 'search.json',
                                searchResultTemplate: '<li><a href="{url}" title="Update Device Status">{title}</a></li>',
                    noResultsText: 'No results found.',
                            limit: 10,
                            fuzzy: true,
                    })
                    </script>
                    <!--end search-->
                </li>
            </ul>
        </div>
        </div>
        <!-- /.container -->
</nav>

<!-- Page Content -->
<div class="container">
  <div id="main">
    <!-- Content Row -->
    <div class="row">
        
        
            <!-- Sidebar Column -->
            <div class="col-md-3" id="tg-sb-sidebar">
                

<ul id="mysidebar" class="nav">
  <li class="sidebarTitle">CoolKit Cloud Platform 2.0</li>
  
  
  <li>
      
      <a href="platformOverview_en.html">Platform Overview</a>
      
      <ul>
          
      </ul>
   </li>
     
      
  <li>
      
      <a href="apiFee_en.html">API Fee</a>
      
      <ul>
          
      </ul>
   </li>
     
      
  <li>
      
      <a href="#">Getting Started</a>
      
      <ul>
          
          
          <li><a href="developerGuide_en.html">Developer Guide</a></li>
          
          
          <li><a href="develop_en.html">Prepare Your Development Environment</a></li>
          
          
          <li><a href="developer_en.html">Become A Developer</a></li>
          
          
          <li><a href="application_en.html">Create Your First Application</a></li>
          
          
          <li><a href="instruction_en.html">General Developer Instruction</a></li>
          
          
          <li><a href="pair_en.html">Pairing Process</a></li>
          
          
          <li><a href="sdk_en.html">SDK</a></li>
          
          
      </ul>
   </li>
     
      
  <li>
      
      <a href="#">API Center</a>
      
      <ul>
          
          
          <li><a href="apiOverview_en.html">API Overview</a></li>
          
          
          <li class="subfolders">
              <a href="#">Region</a>
              <ul>
                  
                  
                  <li><a href="region_en.html">Check current region</a></li>
                  
                  
              </ul>
          </li>
          
          
          <li class="subfolders">
              <a href="#">Account Management</a>
              <ul>
                  
                  
                  <li><a href="code_en.html">Verification code</a></li>
                  
                  
                  <li><a href="register_en.html">Register</a></li>
                  
                  
                  <li><a href="findpassword_en.html">Reset password</a></li>
                  
                  
                  <li><a href="updatePassword_en.html">Change Password</a></li>
                  
                  
                  <li><a href="login_en.html">Login</a></li>
                  
                  
                  <li><a href="token_en.html">Token Refresh</a></li>
                  
                  
              </ul>
          </li>
          
          
          <li class="subfolders">
              <a href="#">Device Management</a>
              <ul>
                  
                  
                  <li><a href="devices_en.html">Device List</a></li>
                  
                  
                  <li><a href="device_en.html">Check Device</a></li>
                  
                  
                  <li><a href="addDevice_en.html">Add Device</a></li>
                  
                  
                  <li><a href="deleteDevice_en.html">Delete Device</a></li>
                  
                  
                  <li><a href="updateDevice_en.html">Change Device Name</a></li>
                  
                  
                  <li><a href="addGsm_en.html">Add GSM Device</a></li>
                  
                  
                  <li><a href="addDeviceGroup_en.html">Add Group</a></li>
                  
                  
                  <li><a href="updateGroup_en.html">Change Group</a></li>
                  
                  
                  <li><a href="deleteGroup_en.html">Delete Group</a></li>
                  
                  
                  <li><a href="addToGroup_en.html">Add device to Group</a></li>
                  
                  
                  <li><a href="findGroup_en.html">Check Group</a></li>
                  
                  
              </ul>
          </li>
          
          
          <li class="subfolders">
              <a href="#">Device Control</a>
              <ul>
                  
                  
                  <li><a href="dispatch_en.html">Server Dispatch</a></li>
                  
                  
                  <li><a href="handshake_en.html">Handshake</a></li>
                  
                  
                  <li><a href="online_en.html">Device Online/Offline</a></li>
                  
                  
                  <li><a href="deviceStatus_en.html">Update/Report Status</a></li>
                  
                  
                  <li><a href="findStatus_en.html">Check Device Status</a></li>
                  
                  
                  <li><a href="share_en.html">Share Device</a></li>
                  
                  
                  <li><a href="shareUpdate_en.html">Update Share</a></li>
                  
                  
                  <li><a href="shareCancel_en.html">Cancel Share</a></li>
                  
                  
                  <li><a href="deviceStatusHttp_en.html">Check Device Status</a></li>
                  
                  
                  <li class="active"><a href="updateStatusHttp_en.html">Update Device Status</a></li>
                  
                  
              </ul>
          </li>
          
          
      </ul>
   </li>
     
      
  <li>
      
      <a href="#">FAQ</a>
      
      <ul>
          
          
          <li><a href="faqOauth_en.html">Authentication</a></li>
          
          
          <li><a href="faqCode_en.html">Verification code</a></li>
          
          
          <li><a href="faqAccount_en.html">Account</a></li>
          
          
          <li><a href="faqDevice_en.html">Device</a></li>
          
          
      </ul>
   </li>
     
      
  <li>
      
      <a href="contactUs_en.html">Contact Us</a>
      
      <ul>
          
      </ul>
   </li>
     
      
      <!-- if you aren't using the accordion, uncomment this block:
         <p class="external">
             <a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
         </p>
         -->
</ul>

<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
<script>$("li.active").parents('li').toggleClass("active");</script>

            </div>
            
        
        <!-- Content Column -->
        <div class="col-md-9" id="tg-sb-content">
            <div class="post-header">
   <h1 class="post-title-main">Update Device Status</h1>
</div>


<div class="post-content">

   
<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
<script>
$( document ).ready(function() {
  // Handler for .ready() called.

$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });

/* this offset helps account for the space taken up by the floating toolbar. */
$('#toc').on('click', 'a', function() {
  var target = $(this.getAttribute('href'))
    , scroll_target = target.offset().top

  $(window).scrollTop(scroll_target - 10);
  return false
})
  
});
</script>

<div id="toc"></div>

    
   <p>Update device status such as turning on/off device, setting up timers, etc.</p>
<ul>
  <li>Production environment URL: <code class="highlighter-rouge">https://cn(区域)-api.coolkit.cn:8080/api/user/device/status</code></li>
  <li>Test environment URL: <code class="highlighter-rouge">https://testapi.coolkit.cn:8080/api/user/device/status</code></li>
  <li>Request method： POST</li>
  <li>Request parameters：</li>
</ul>

<table>
  <thead>
    <tr>
      <th style="text-align: left">Parameter</th>
      <th style="text-align: left">Required</th>
      <th style="text-align: left">Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td style="text-align: left">deviceid</td>
      <td style="text-align: left">Yes</td>
      <td style="text-align: left">String</td>
      <td>device id</td>
    </tr>
    <tr>
      <td style="text-align: left">params</td>
      <td style="text-align: left">Yes</td>
      <td style="text-align: left">JSON</td>
      <td> </td>
    </tr>
  </tbody>
</table>

<p>params example：</p>

<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Example of single channel switch：
"params":{
   "switch":"on"
}
	 
Example of multi-channel switch:
"params":{
   "switches":[
      {
         "switch":"off",
         "outlet":0
      },
      {
         "switch":"off",
         "outlet":1
      },
      {
         "switch":"off",
         "outlet":2
      },
      {
         "switch":"off",
         "outlet":3
      }
   ]
}
</code></pre></div></div>

<p>Timer examples：
Generally speaking, multiple timers can be added to a device. Everytime timer is added, modified, or deleted, complete timer array needs to be resubmitted. For example,we have two timers now,when we add another, the timer array submitted will include the info of both the new timer and the previous two.</p>

<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Single timer, which activates once only.

"params":{
        "timers":[
            {
                "enabled":1, //1 means it is enabled
                "mId":"c102f00f-db6f-fef0-f296-9dd10fdc2193", //random,for app to locate it
                "type":"once",  //for app only, once means single timer, repeat means repeating timer
                "at":"2017-07-24T08:28:00.000Z", //activation time,based on GMT+0
                "do":{   //the operation to trigger
                    "switch":"on"   //this example shows the operation of single-channel switch.Refer to multi-channel example above for multi-channel device.
                },
                "coolkit_timer_type":"once" //for app only
            }
        ]
}


Repeating timer：
"params":{
        "timers":[
            {
                "enabled":1,
                "mId":"847b296e-9043-ac94-ca37-aa5f91d22338",
                "type":"repeat", // a repeating timer
                "at":"36 8 * * 1,3",//refer to cron for time format
                "do":{
                    "switch":"on"
                },
                "coolkit_timer_type":"repeat" //activates repeatedly
            }
        ]
}

Loop timer：
"params":{
        "timers":[
            {
                "enabled":1,
                "mId":"847b296e-9043-ac94-ca37-aa5f91d22338",
                "type":"duration", 
                "at":"2018-11-21T10:24:00.980Z 10 5",//start time, loop cycle, 10 mins,reactivates after, 5 mins
                "startDo":{
                    "switch":"on"  //start action
                },
           "endDo":{
                    "switch":"off"  //end action
                },
                "coolkit_timer_type":"duration" //activates repeatedly
            }
        ]
}

Countdown timer（Activates after specified time, which fires once only.A qucik way to add timer）：
"params":{
        "timers":[
            {
                "enabled":1,
                "mId":"95303c64-fbb4-f497-1341-c592432d1d0d",
                "type":"once",
                "at":"2017-07-24T09:10:43.223Z",
                "do":{
                    "switch":"on"
                },
                "period":"30",
                "coolkit_timer_type":"delay"  //countdown timer
            }
        ]
}
</code></pre></div></div>

<ul>
  <li>Return parameters</li>
</ul>

<table>
  <thead>
    <tr>
      <th style="text-align: left">Parameter</th>
      <th style="text-align: left">Required</th>
      <th style="text-align: left">Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td style="text-align: left">error</td>
      <td style="text-align: left">Yes</td>
      <td style="text-align: left">Int</td>
      <td>error code</td>
    </tr>
    <tr>
      <td style="text-align: left">deviceid</td>
      <td style="text-align: left">Yes</td>
      <td style="text-align: left">String</td>
      <td>device id</td>
    </tr>
  </tbody>
</table>

<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>error code
0:success
400:wrong parameter
401:authorization failed
403:no permission
500:server error
503：Device offline
</code></pre></div></div>


</div>

<hr class="shaded"/>

<footer>
            <div class="row">
                <div class="col-lg-12 footer">
               &copy;2019 Coolkit Technology Co.,Ltd. All rights reserved. <br />
<span>Page last updated:</span> 2019-03-20<br/>
<p><img src="images/coolkit.png" alt="CoolKit"/></p>
                </div>
            </div>
</footer>


        </div>
    <!-- /.row -->
</div>
<!-- /.container -->
</div>
<!-- /#main -->
    </div>

</body>
</html>