[jira] [Commented] (QUARKS-99) Improve documentation for IotfDevice

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/QUARKS-99?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15220881#comment-15220881 ] 

ASF GitHub Bot commented on QUARKS-99:
--------------------------------------

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

----


> Improve documentation for IotfDevice
> ------------------------------------
>
>                 Key: QUARKS-99
>                 URL: https://issues.apache.org/jira/browse/QUARKS-99
>             Project: Quarks
>          Issue Type: Task
>          Components: Connectors
>            Reporter: Daniel John Debrunner
>            Assignee: Daniel John Debrunner
>
> It's not at all clear form the docs what needs to be passed to the constructor to create the device.
> It's either a device.cfg file that looks like the one in the scripts/connectors/iotf
> or a set of properties
> https://docs.internetofthings.ibmcloud.com/devices/libraries/java.html
> //Provide the device specific data, as well as Auth-key and token using Properties class
>                   Properties options = new Properties();
>                   options.setProperty("org", "uguhsp");
>                   options.setProperty("type", "iotsample-arduino");
>                   options.setProperty("id", "00aabbccde03");
>                   options.setProperty("auth-method", "token");
>                   options.setProperty("auth-token", "AUTH TOKEN FOR DEVICE");
>  



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)