Skip to content

Commit

Permalink
Merge pull request #1414 from jumpingliu/issue-1338
Browse files Browse the repository at this point in the history
fix: remove WalkthroughDeviceService on docs
  • Loading branch information
cloudxxx8 authored Feb 6, 2025
2 parents 179a60d + 48175f0 commit 2a4ed8b
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 77 deletions.
2 changes: 1 addition & 1 deletion docs_src/walk-through/Ch-WalkthroughDeviceProfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,4 +140,4 @@ Click on the link below to download and save the device profile (YAML) to your s
#### Test the GET API
If you make a GET call to the `http://localhost:59881/api/{{api_version}}/deviceprofile/all` URL (with Postman or curl) you will get a listing (in JSON) of all the device profiles (and all of its associated `deviceResource` and `deviceCommand`) currently defined in your instance of EdgeX, including the one you just added.

[<Back](Ch-WalkthroughUseCase.md){: .md-button } [Next>](Ch-WalkthroughDeviceService.md){: .md-button }
[<Back](Ch-WalkthroughUseCase.md){: .md-button } [Next>](Ch-WalkthroughProvision.md){: .md-button }
72 changes: 0 additions & 72 deletions docs_src/walk-through/Ch-WalkthroughDeviceService.md

This file was deleted.

5 changes: 2 additions & 3 deletions docs_src/walk-through/Ch-WalkthroughProvision.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ For the sake of this demonstration, the call to core metadata 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
[`DeviceProfile`](./Ch-WalkthroughDeviceProfile.md), a
[`DeviceService`](./Ch-WalkthroughDeviceService.md), and
[`DeviceProfile`](./Ch-WalkthroughDeviceProfile.md) and
contain one or more `Protocols` that define how and where to communicate with the device (possibly providing its address).

When creating a device, you specify both the admin state (just as you did for a device service) and an operating state. The operating state (aka op state) provides an indication on the part of EdgeX about the internal operating status of the device. The operating state is not set externally (as by another system or man), it is a signal from within EdgeX (and potentially the device service itself) about the condition of the device. The operating state of the device may be either `UP` or `DOWN` (it may alsy be `UNKNOWN` if the state cannot be determined). When the operating state of the device is `DOWN`, it is either experiencing some difficulty or going through some process (for example an upgrade) which does not allow it to function in its normal capacity.
Expand Down Expand Up @@ -88,4 +87,4 @@ all devices associated to a given `DeviceProfile`.
curl -X GET http://localhost:59881/api/{{api_version}}/device/profile/name/camera-monitor-profile | json_pp
```

[<Back](Ch-WalkthroughDeviceService.md){: .md-button } [Next>](Ch-WalkthroughCommands.md){: .md-button }
[<Back](Ch-WalkthroughDeviceProfile.md){: .md-button } [Next>](Ch-WalkthroughCommands.md){: .md-button }
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,6 @@ nav:
- walk-through/Ch-WalkthroughSetup.md
- walk-through/Ch-WalkthroughUseCase.md
- walk-through/Ch-WalkthroughDeviceProfile.md
- walk-through/Ch-WalkthroughDeviceService.md
- walk-through/Ch-WalkthroughProvision.md
- walk-through/Ch-WalkthroughCommands.md
- walk-through/Ch-WalkthroughReading.md
Expand Down

0 comments on commit 2a4ed8b

Please sign in to comment.