You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@edgent.apache.org by ddebrunner <gi...@git.apache.org> on 2016/04/01 01:54:49 UTC
[GitHub] incubator-quarks pull request: QUARKS-99 Improve Javadoc for IotfD...
GitHub user ddebrunner opened a pull request:
https://github.com/apache/incubator-quarks/pull/64
QUARKS-99 Improve Javadoc for IotfDevice
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/ddebrunner/incubator-quarks iotf-javadoc-quarks-99
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-quarks/pull/64.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #64
----
commit bd03d5064a52ec49adeef0a2275ef7ed9d3658ea
Author: Dan Debrunner <dj...@debrunners.com>
Date: 2016-03-31T23:54:35Z
QUARKS-99 Improve Javadoc for IotfDevice
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-quarks pull request: QUARKS-99 Improve Javadoc for IotfD...
Posted by ddebrunner <gi...@git.apache.org>.
Github user ddebrunner closed the pull request at:
https://github.com/apache/incubator-quarks/pull/64
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-quarks pull request: QUARKS-99 Improve Javadoc for IotfD...
Posted by ddebrunner <gi...@git.apache.org>.
Github user ddebrunner commented on a diff in the pull request:
https://github.com/apache/incubator-quarks/pull/64#discussion_r58205762
--- Diff: connectors/iotf/src/main/java/quarks/connectors/iotf/IotfDevice.java ---
@@ -69,11 +109,56 @@ public IotfDevice(Topology topology, Properties options) {
this.connector = new IotfConnector(options);
}
+ /**
+ * Create a connector to the IBM Watson IoT Platform Bluemix service.
+ * Device identifier and authorization are specified
+ * by a configuration file.
+ * <BR>
+ * The format of the file is:
+ * <pre>
+ * <code>
+ * [device]
+ * org = <em>organization identifier</em>
+ * type = <em>device type</em>
+ * id = <em>device identifier</em>
+ * auth-method = token
+ * auth-token = <em>authorization token</em>
+ * </code>
+ * </pre>
+ * For example:
+ * <pre>
+ * <code>
+ * [device]
+ * org = uguhsp
+ * type = iotsample-arduino
+ * id = 00aabbccde03
+ * auth-method = token
+ * auth-token = AJfKQV@&bBo@VX6Dcg
+ * </code>
+ * </pre>
+ * <p>
+ * Connecting to the server occurs when the topology is submitted for
+ * execution.
+ * </p>
+ * @param topology the connector's associated {@code Topology}.
+ * @param optionsFile File containing connection information.
+ */
public IotfDevice(Topology topology, File optionsFile) {
this.topology = topology;
this.connector = new IotfConnector(optionsFile);
}
+ /**
+ * Create an {@code IotfDevice} connector to the Quickstart service.
+ * Quickstart service requires no-sign up to use, but only supports
+ * device commands for a single
--- End diff --
Good catch!
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-quarks pull request: QUARKS-99 Improve Javadoc for IotfD...
Posted by ddebrunner <gi...@git.apache.org>.
GitHub user ddebrunner reopened a pull request:
https://github.com/apache/incubator-quarks/pull/64
QUARKS-99 Improve Javadoc for IotfDevice
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/ddebrunner/incubator-quarks iotf-javadoc-quarks-99
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-quarks/pull/64.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #64
----
commit bd03d5064a52ec49adeef0a2275ef7ed9d3658ea
Author: Dan Debrunner <dj...@debrunners.com>
Date: 2016-03-31T23:54:35Z
QUARKS-99 Improve Javadoc for IotfDevice
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-quarks pull request: QUARKS-99 Improve Javadoc for IotfD...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/incubator-quarks/pull/64
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-quarks pull request: QUARKS-99 Improve Javadoc for IotfD...
Posted by dlaboss <gi...@git.apache.org>.
Github user dlaboss commented on a diff in the pull request:
https://github.com/apache/incubator-quarks/pull/64#discussion_r58195465
--- Diff: connectors/iotf/src/main/java/quarks/connectors/iotf/IotfDevice.java ---
@@ -69,11 +109,56 @@ public IotfDevice(Topology topology, Properties options) {
this.connector = new IotfConnector(options);
}
+ /**
+ * Create a connector to the IBM Watson IoT Platform Bluemix service.
+ * Device identifier and authorization are specified
+ * by a configuration file.
+ * <BR>
+ * The format of the file is:
+ * <pre>
+ * <code>
+ * [device]
+ * org = <em>organization identifier</em>
+ * type = <em>device type</em>
+ * id = <em>device identifier</em>
+ * auth-method = token
+ * auth-token = <em>authorization token</em>
+ * </code>
+ * </pre>
+ * For example:
+ * <pre>
+ * <code>
+ * [device]
+ * org = uguhsp
+ * type = iotsample-arduino
+ * id = 00aabbccde03
+ * auth-method = token
+ * auth-token = AJfKQV@&bBo@VX6Dcg
+ * </code>
+ * </pre>
+ * <p>
+ * Connecting to the server occurs when the topology is submitted for
+ * execution.
+ * </p>
+ * @param topology the connector's associated {@code Topology}.
+ * @param optionsFile File containing connection information.
+ */
public IotfDevice(Topology topology, File optionsFile) {
this.topology = topology;
this.connector = new IotfConnector(optionsFile);
}
+ /**
+ * Create an {@code IotfDevice} connector to the Quickstart service.
+ * Quickstart service requires no-sign up to use, but only supports
+ * device commands for a single
--- End diff --
"...for a single" ?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---