Skip to content

Commit

Permalink
Merge pull request IBM-Cloud#1255 from IBM-Bluemix/JaniceHamrickBranch2
Browse files Browse the repository at this point in the history
IoT - Sprint 84 Interim Deployment IBM-Cloud#622
  • Loading branch information
janicehamrick authored Mar 31, 2017
2 parents 5438b85 + 25acc57 commit 15a5bea
Show file tree
Hide file tree
Showing 9 changed files with 23 additions and 60 deletions.
28 changes: 0 additions & 28 deletions services/IoT/about_iotplatform.md

This file was deleted.

4 changes: 2 additions & 2 deletions services/IoT/devices/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
copyright:
years: 2015, 2017

lastupdated: "2017-03-14"
lastupdated: "2017-03-21"
---

{:new_window: target="blank"}
Expand Down Expand Up @@ -48,7 +48,7 @@ Use one of the following URLs to submit a ``POST`` request from a device that is

<pre class="pre"><code class="hljs">https://<var class="keyword varname">orgId</var>.messaging.internetofthings.ibmcloud.com:8883/api/v0002/device/types/<var class="keyword varname">typeId</var>/devices/<var class="keyword varname">deviceId</var>/events/<var class="keyword varname">eventId</var></code></pre>

**Note: **Port 443, the default SSL port, can also be specified for secure HTTP API calls.
**Note:** Port 443, the default SSL port, can also be specified for secure HTTP API calls.

If you are connecting a device or application to the Quickstart service, use one of the following URLs instead:

Expand Down
6 changes: 3 additions & 3 deletions services/IoT/devices/device_mgmt/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ lastupdated: "2017-03-14"

---

{:new_window: target="_blank"}
{:new_window: target="\_blank"}
{:shortdesc: .shortdesc}
{:screen: .screen}
{:codeblock: .codeblock}
Expand Down Expand Up @@ -204,10 +204,10 @@ Topic: iotdm-1/response

A device uses an Update Location request to manage the location data for a device. The location metadata for a device can be updated in {{site.data.keyword.iot_short_notm}} in the following ways:

#### Automatic device location updates
### Automatic device location updates
- The device notifies {{site.data.keyword.iot_short_notm}} about the location update. The device retrieves its location from a GPS receiver and sends a device management message to the {{site.data.keyword.iot_short_notm}} instance to update its location. The time stamp captures the time at which the location was retrieved from the GPS receiver. The time stamp is valid even if there is a delay in sending the location update message. If time stamp is omitted from the device management message, the date and time of the message receipt is used to update the location metadata.

#### Manual device location updates by using the REST API
### Manual device location updates by using the REST API
- You can manually set the location metadata for a static device by using the {{site.data.keyword.iot_short_notm}} REST API when the device is registered. You can also modify the location later. The time stamp setting is optional, but when omitted, the current date and time is set in the location metadata for the device.

### Location updates that are triggered by devices
Expand Down
12 changes: 6 additions & 6 deletions services/IoT/devices/libraries/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

copyright:
years: 2015, 2017
lastupdated: "2017-03-14"
lastupdated: "2017-03-21"

---

{:new_window: target="_blank"}
{:new_window: target="\_blank"}
{:shortdesc: .shortdesc}
{:screen: .screen}
{:codeblock: .codeblock}
Expand Down Expand Up @@ -294,9 +294,9 @@ In addition to using MQTT, you can also configure your devices to publish events

1. Construct a `DeviceClient` instance by using the properties file.
2. Construct an event that needs to be published.
3. Specify the event name, and then publish the event by using the ``publishEventOverHTTP()`` method, as shown in the following code sample:
3. Specify the event name, and then publish the event by using the `publishEventOverHTTP()` method, as shown in the following code sample:

``` sourceCode
```
DeviceClient myClient = new DeviceClient(deviceProps);
JsonObject event = new JsonObject();
Expand All @@ -307,7 +307,7 @@ event.addProperty("mem", 70);
boolean response = myClient.api().publishDeviceEventOverHTTP("blink", event, ContentType.json);
```

To view the entire code, see the [HttpDeviceEventPublish] device example.
To view the entire code, see the [HttpDeviceEventPublish ![External link icon](../../../../icons/launch-glyph.svg "External link icon")] device example.{: new_window}

Based on the settings in the properties file, the ``publishEventOverHTTP()`` method publishes the event in either Quickstart mode or in registered flow mode. When the organization ID in the properties file is set to `quickstart`, the ``publishEventOverHTTP()`` method publishes the event to the device example quickstart service and publishes the event in plain HTTP format. When a valid registered organization is specified in the properties file, events are securely published through HTTPS.

Expand All @@ -329,7 +329,7 @@ The messages are returned as an instance of the `Command` class, which contains
|`timestamp` |org.joda.time.DateTime|The date and time of the event.|


``` sourceCode
```
package com.ibm.iotf.sample.client.device;
import java.util.Properties;
Expand Down
8 changes: 4 additions & 4 deletions services/IoT/devices/mqtt.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

copyright:
years: 2015, 2017
lastupdated: "2016-11-17"
lastupdated: "2017-03-21"

---

Expand Down Expand Up @@ -59,7 +59,7 @@ The password for each device is the unique authentication token that was generat

Devices publish to the event topics in the following format:

<pre class="pre">iot-2/evt/<var class="keyword varname">event_id</var>/fmt/<var class="keyword varname">format_string</var></pre>
<pre class="pre"><code class="hljs">iot-2/evt/<var class="keyword varname">event_id</var>/fmt/<var class="keyword varname">format_string</var></code></pre>
{: codeblock}

Where
Expand All @@ -78,7 +78,7 @@ Where

Devices can subscribe to command topics in the following format:

<pre class="pre">iot-2/cmd/<var class="keyword varname">command_id</var>/fmt/<var class="keyword varname">format_string</var></pre>
<pre class="pre"><code class="hljs">iot-2/cmd/<var class="keyword varname">command_id</var>/fmt/<var class="keyword varname">format_string</var></code></pre>
{: codeblock}

Where
Expand Down Expand Up @@ -126,7 +126,7 @@ All messages are sent in JSON format.
**Requests**
Requests are formatted as shown in the following code sample:

<pre class="pre">{ "d": {...}, "<var class="keyword varname">reqId</var>": "b53eb43e-401c-453c-b8f5-94b73290c056" }</pre>
<pre class="pre"><code class="hljs">{ "d": {...}, "<var class="keyword varname">reqId</var>": "b53eb43e-401c-453c-b8f5-94b73290c056" }</code></pre>
{: codeblock}

Where:
Expand Down
2 changes: 1 addition & 1 deletion services/IoT/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

copyright:
years: 2016, 2017
lastupdated: "2017-03-17"
lastupdated: "2017-03-31"

---

Expand Down
6 changes: 3 additions & 3 deletions services/IoT/information_management/twc_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

copyright:
years: 2016, 2017
lastupdated: "2017-03-13"
lastupdated: "2017-03-21"

---

Expand All @@ -22,11 +22,11 @@ Weather data from The Weather Company appears in the device details view if an u

**Important:** Only managed devices can set their own locations. All unmanaged devices must have their locations set manually by using the API. For more information on setting a device location, see [Update Location requests](../../devices/device_mgmt/index.html#update-location).

### REST APIs for The Weather Company
## REST APIs for The Weather Company
To access the REST API for The Weather Company, see the
Device Location Weather section in the [{{site.data.keyword.iot_short_notm}} HTTP REST API ![External link icon](../../../../icons/launch-glyph.svg)](https://docs.internetofthings.ibmcloud.com/swagger/v0002.html#!/Device_Location_Weather){: new_window} documentation.

### Viewing weather data
## Viewing weather data

To view the weather data retrieved for a device location:
1. Click the device in the **Devices** pane.
Expand Down
2 changes: 1 addition & 1 deletion services/IoT/reference/security/connect_devices_apps_gw.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To connect device, application, and gateway clients to your {{site.data.keyword.

### HTTP REST API connection URL

<pre class="pre">https://<var class="keyword varname">orgId</var>.internetofthings.ibmcloud.com/api/v0002/device/types/<var class="keyword varname">typeId</var>/devices/<var class="keyword varname">deviceId</var>/events/<var class="keyword varname">eventId</var></pre>
<pre class="pre"><code class="hljs">https://<var class="keyword varname">orgId</var>.internetofthings.ibmcloud.com/api/v0002/device/types/<var class="keyword varname">typeId</var>/devices/<var class="keyword varname">deviceId</var>/events/<var class="keyword varname">eventId</var></code></pre>
{: codeblock}

**Notes**
Expand Down
15 changes: 3 additions & 12 deletions services/IoT/visualizingdata_sample.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

copyright:
years: 2016, 2017
lastupdated: "2016-06-29"
lastupdated: "2017-03-20"

---

Expand All @@ -25,7 +25,7 @@ Before you can visualize your data, your must take the following actions:

- Register your devices to your {{site.data.keyword.iot_short_notm}} organization.
- Ensure that your devices are sending events to the {{site.data.keyword.iot_short_notm}}.
- [Download the visualization sample](https://github.com/ibm-messaging/iot-visualization/archive/v0.2.0.zip) from the github repository and extract the .zip file.
- [Download the visualization sample](https://github.com/ibm-watson-iot/rickshaw4iot/archive/master.zip) from the github repository and extract the .zip file.
- [Install the cf command-line tool](../../starters/install_cli.html) from {{site.data.keyword.Bluemix_notm}}.

## Running the sample in {{site.data.keyword.Bluemix_notm}}
Expand Down Expand Up @@ -106,13 +106,4 @@ The file that references the Paho MQTT library to subscribe to device topics and

Device events are passed to the `realtimeGraph.js` file to plot the graph.

## Customizing the historic data display
{: #customize_historical_display}

The directory containing graphical visualization code for historic device data is `public/js/historian`. The graphing logic can be customized by editing `public/js/historian/historianGraph.js`.

The file that controls ReST API calls to collect historic device data is `public/js/historian/historian.js`.

Historic data is passed to the `historianGraph.js` file to plot the graph.

A more detailed developer's guide is available from the Github iot-visualization wiki.
A more detailed developer's guide is available from the [Github wiki ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://github.com/ibm-watson-iot/rickshaw4iot/wiki){:new_window}.

0 comments on commit 15a5bea

Please sign in to comment.