Skip to content

Commit

Permalink
Replace Addressable With Protocols
Browse files Browse the repository at this point in the history
In API walk through, replaced addressable with protocols in device
creation call.  Example did not have a protocols field and result of
POST was a _no supporting protocol specified for device_ result.

edgexfoundry#8

Signed-off-by: Michael W. Estrin <[email protected]>
  • Loading branch information
michaelestrin committed Jul 12, 2019
1 parent c45ca24 commit 26cea16
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions walk-through/Ch-WalkthroughProvision.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,15 @@ Adding your device

See `APIs Core Services Metadata`_

For the sake of this demonstration, the call to Core Metadata below will provision the human/dog counting monitor camera as if the Device Service discovered it (by some unknown means) and provisioned the Device as part of some startup process. To create a Device, it must be associated to a `Device Profile <Ch-WalkthroughDeviceProfile.html>`_ (by name or id), a `Device Service <Ch-WalkthroughDeviceService.html>`_ (by name or id), and `Addressable <Ch-WalkthroughData.html#addressables>`_ (by name or id). When calling each of the POST calls above, the ID was returned by the associated micro service and used in the call below. In this example, the names of Device Profile, Device Service, and Addressable are used.
For the sake of this demonstration, the call to Core Metadata below will provision the human/dog counting monitor camera as if the Device Service discovered it (by some unknown means) and provisioned the Device as part of some startup process. To create a Device, it must be associated to a `Device Profile <Ch-WalkthroughDeviceProfile.html>`_ (by name or id), a `Device Service <Ch-WalkthroughDeviceService.html>`_ (by name or id), and contain one or more `Protocols <Ch-WalkthroughData.html#addressables>`_ defining its address. When calling each of the POST calls above, the ID was returned by the associated micro service and used in the call below. In this example, the names of Device Profile, Device Service, and Protocols are used.

::

POST to http://localhost:48081/api/v1/device

::

BODY: {"name":"countcamera1","description":"human and dog counting camera #1","adminState":"unlocked","operatingState":"enabled","addressable":{"name":"camera1 address"},"labels":
["camera","counter"],"location":"","service":{"name":"camera control device service"},"profile":{"name":"camera monitor profile"}}
BODY: {"name":"countcamera1","description":"human and dog counting camera #1","adminState":"unlocked","operatingState":"enabled","protocols":{"camera protocol":{"camera address":"camera 1"}},"labels": ["camera","counter"],"location":"","service":{"name":"camera control device service"},"profile":{"name":"camera monitor profile"}}

Note that ``camera monitor profile`` was created by the :download:`CameraMonitorProfile.yml <EdgeX_CameraMonitorProfile.yml>` you uploaded in a previous step.

Expand Down

0 comments on commit 26cea16

Please sign in to comment.