diff --git a/docs_src/microservices/device/services/Ch-DeviceServiceList.md b/docs_src/microservices/device/services/Ch-DeviceServiceList.md index 03bd5046b3..97da16a9fc 100644 --- a/docs_src/microservices/device/services/Ch-DeviceServiceList.md +++ b/docs_src/microservices/device/services/Ch-DeviceServiceList.md @@ -2,20 +2,20 @@ The following table lists the EdgeX device services and protocols they support. -| Device Service Repository | Protocol | Status | Comments | Documentation | -|----------------------------------------------------------------------------------------------|----------|--------|----------|--------------------------------------------------------------| +| Device Service Repository | Protocol | Status | Comments | Documentation | +|---------------------------------------------------------------------------------------------------|----------|--------|----------|--------------------------------------------------------------| +| [device-bacnet-c]( https://github.com/edgexfoundry/device-bacnet-c/tree/{{edgexversion}}) | BACnet | Active | Supports BACnet via ethernet (IP) or serial (MSTP). Uses the Steve Karag BACnet stack | [device-bacnet docs](./device-bacnet.md) | +| [device-coap-c]( https://github.com/edgexfoundry/device-coap-c/tree/{{edgexversion}}) | CoAP | Active | EdgeX device service for CoAP-based REST protocol | [device-coap docs](./device-coap.md) | | +| [device-gpio]( https://github.com/edgexfoundry/device-gpio/tree/{{edgexversion}}) | GPIO | Active | Linux only; uses sysfs ABI | [device-gpio docs](./device-gpio.md) | +| [device-modbus-go]( https://github.com/edgexfoundry/device-modbus-go/tree/{{edgexversion}}) | Modbus | Active | Supports Modbus over TCP or RTU | [device-modbus docs](./device-modbus.md) | +| [device-mqtt-go]( https://github.com/edgexfoundry/device-mqtt-go/tree/{{edgexversion}}) | MQTT | Active | Two way communications via multiple MQTT topics | [device-mqtt docs](./device-mqtt.md) | | [device-onvif-camera](https://github.com/edgexfoundry/device-onvif-camera/tree/{{edgexversion}}) | ONVIF | Active | Full implementation of ONVIF spec. Note that not all cameras implement the complete ONVIF spec. | [device-onvif-camera docs](./device-onvif-camera/General.md) | +| [device-rest-go]( https://github.com/edgexfoundry/device-rest-go/tree/{{edgexversion}}) | REST | Active| provides one-way communications only. Allows posting of binary and JSON data via REST. Events are single reading only.| [device-rest docs](./device-rest.md) | +| [device-rfid-llrp-go]( https://github.com/edgexfoundry/device-rfid-llrp-go/tree/{{edgexversion}}) | LLRP | Active| Communications with RFID readers via LLRP. | [device-rfid-llrp docs](./device-rfid-llrp.md) | +| [device-snmp-go]( https://github.com/edgexfoundry/device-snmp-go/tree/{{edgexversion}}) | SNMP | Active| Basic implementation of SNMP protocol. Async callbacks and traps not currently supported. | [device-snmp docs](./device-snmp.md) | +| [device-uart]( https://github.com/edgexfoundry/device-uart/tree/{{edgexversion}}) | UART |Active| Linux only; for connecting serial UART devices to EdgeX | [device-urt docs](./device-uart.md) | | [device-usb-camera](https://github.com/edgexfoundry/device-usb-camera/tree/{{edgexversion}}) | USB | Active | USB using V4L2 API. ONLY works on Linux with kernel v5.10 or higher. Includes RTSP server for video streaming. | [device-usb-camera docs](./device-usb-camera/General.md) | -| [device-rest-go]( https://github.com/edgexfoundry/device-rest-go/tree/{{edgexversion}}) | REST | Active| provides one-way communications only. Allows posting of binary and JSON data via REST. Events are single reading only.| | -| [device-rfid-llrp-go]( https://github.com/edgexfoundry/device-rfid-llrp-go/tree/{{edgexversion}}) | LLRP | Active| Communications with RFID readers via LLRP. | | -| [device-snmp-go]( https://github.com/edgexfoundry/device-snmp-go/tree/{{edgexversion}}) | SNMP | Active| Basic implementation of SNMP protocol. Async callbacks and traps not currently supported. | | | [device-virtual-go]( https://github.com/edgexfoundry/device-virtual-go/tree/{{edgexversion}}) | | Active| Simulates sensor readings of type binary, Boolean, float, integer and unsigned integer | [device-virtual docs](./device-virtual/Ch-VirtualDevice.md) | -| [device-mqtt-go]( https://github.com/edgexfoundry/device-mqtt-go/tree/{{edgexversion}}) | MQTT | Active | Two way communications via multiple MQTT topics | | -| [device-modbus-go]( https://github.com/edgexfoundry/device-modbus-go/tree/{{edgexversion}}) | Modbus | Active | Supports Modbus over TCP or RTU | | -| [device-gpio]( https://github.com/edgexfoundry/device-gpio/tree/{{edgexversion}}) | GPIO | Active | Linux only; uses sysfs ABI | | -| [device-bacnet-c]( https://github.com/edgexfoundry/device-bacnet-c/tree/{{edgexversion}}) | BACnet | Active | Supports BACnet via ethernet (IP) or serial (MSTP). Uses the Steve Karag BACnet stack | | -| [device-coap-c]( https://github.com/edgexfoundry/device-coap-c/tree/{{edgexversion}}) | CoAP | Active | This service is in the process of being redeveloped and expanded for upcoming release for Kamakura – and will support Thread as a subset of functionality. Currently supports CoAP-based REST and is one way communications (read-only) | | -| [device-uart]( https://github.com/edgexfoundry/device-uart/tree/{{edgexversion}}) | UART |Active| Linux only; for connecting serial UART devices to EdgeX | | !!! note Check the above Device Service README(s) for known devices that have been tested with the Device Service. Not all Device Service READMEs will have this information. diff --git a/docs_src/microservices/device/services/device-bacnet.md b/docs_src/microservices/device/services/device-bacnet.md new file mode 100644 index 0000000000..4a96ea49c2 --- /dev/null +++ b/docs_src/microservices/device/services/device-bacnet.md @@ -0,0 +1,5 @@ +# Device BACNET + +Device service for BACnet protocol written in C. This service may be built to support BACnet devices connected via ethernet (/IP) or serial (/MSTP). + +See [README](https://github.com/edgexfoundry/device-bacnet-c/tree/{{edgexversion}}#readme) for more details \ No newline at end of file diff --git a/docs_src/microservices/device/services/device-coap.md b/docs_src/microservices/device/services/device-coap.md new file mode 100644 index 0000000000..0690126ade --- /dev/null +++ b/docs_src/microservices/device/services/device-coap.md @@ -0,0 +1,5 @@ +# Device COAP + +Device service for CoAP-based REST protocol + +See [README](https://github.com/edgexfoundry/device-coap-c/tree/{{edgexversion}}#readme) for more details \ No newline at end of file diff --git a/docs_src/microservices/device/services/device-gpio.md b/docs_src/microservices/device/services/device-gpio.md new file mode 100644 index 0000000000..d33cf9948a --- /dev/null +++ b/docs_src/microservices/device/services/device-gpio.md @@ -0,0 +1,5 @@ +# Device GPIO + +Device service for connecting GPIO devices to EdgeX + +See [README](https://github.com/edgexfoundry/device-gpio/tree/{{edgexversion}}#readme) for more details \ No newline at end of file diff --git a/docs_src/microservices/device/services/device-modbus.md b/docs_src/microservices/device/services/device-modbus.md new file mode 100644 index 0000000000..3298905263 --- /dev/null +++ b/docs_src/microservices/device/services/device-modbus.md @@ -0,0 +1,5 @@ +# Device ModBus + +Device service for connecting Modbus devices to EdgeX. + +See [README](https://github.com/edgexfoundry/device-modbus-go/tree/{{edgexversion}}#readme) for more details \ No newline at end of file diff --git a/docs_src/microservices/device/services/device-mqtt.md b/docs_src/microservices/device/services/device-mqtt.md new file mode 100644 index 0000000000..d6b4c1ae12 --- /dev/null +++ b/docs_src/microservices/device/services/device-mqtt.md @@ -0,0 +1,8 @@ +# Device MQTT + +Device service for connecting a MQTT enabled devices to EdgeX. + +See [README](https://github.com/edgexfoundry/device-mqtt-go/tree/{{edgexversion}}#readme) for more details + +Also see [Adding MQTT Device Tutorial](../../../../examples/Ch-ExamplesAddingMQTTDevice) for +more details on using Device MQTT. \ No newline at end of file diff --git a/docs_src/microservices/device/services/device-rest.md b/docs_src/microservices/device/services/device-rest.md new file mode 100644 index 0000000000..f138704665 --- /dev/null +++ b/docs_src/microservices/device/services/device-rest.md @@ -0,0 +1,5 @@ +# Device REST + +Device service for REST protocol + +See [README](https://github.com/edgexfoundry/device-rest-go/tree/{{edgexversion}}#readme) for more details \ No newline at end of file diff --git a/docs_src/microservices/device/services/device-rfid-llrp.md b/docs_src/microservices/device/services/device-rfid-llrp.md new file mode 100644 index 0000000000..4de4cf0db9 --- /dev/null +++ b/docs_src/microservices/device/services/device-rfid-llrp.md @@ -0,0 +1,5 @@ +# Device RFID LLRP + +Device service for communicating with LLRP-based RFID readers. + +See [README](https://github.com/edgexfoundry/device-rfid-llrp-go/tree/{{edgexversion}}#readme) for more details \ No newline at end of file diff --git a/docs_src/microservices/device/services/device-snmp.md b/docs_src/microservices/device/services/device-snmp.md new file mode 100644 index 0000000000..deb0f11603 --- /dev/null +++ b/docs_src/microservices/device/services/device-snmp.md @@ -0,0 +1,5 @@ +# Device SNMP + +Device service for SNMP protocol + +See [README](https://github.com/edgexfoundry/device-snmp-go/tree/{{edgexversion}}#readme) for more details \ No newline at end of file diff --git a/docs_src/microservices/device/services/device-uart.md b/docs_src/microservices/device/services/device-uart.md new file mode 100644 index 0000000000..335bb5638e --- /dev/null +++ b/docs_src/microservices/device/services/device-uart.md @@ -0,0 +1,5 @@ +# Device UART + +Device service to connect serial UART devices to EdgeX + +See [README](https://github.com/edgexfoundry/device-uart/tree/{{edgexversion}}#readme) for more details \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 0c1573eb2a..c510b32a46 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -67,48 +67,57 @@ nav: - Device SDK API: microservices/device/sdk/SDK-Go-API.md - Device Services: - Available Services: microservices/device/services/Ch-DeviceServiceList.md - - Device Onvif Camera: - - microservices/device/services/device-onvif-camera/General.md - - microservices/device/services/device-onvif-camera/swagger.md - - Walkthrough: - - microservices/device/services/device-onvif-camera/Walkthrough/setup.md - - microservices/device/services/device-onvif-camera/Walkthrough/deployment.md - - microservices/device/services/device-onvif-camera/Walkthrough/general-usage.md - - microservices/device/services/device-onvif-camera/Walkthrough/custom-build.md - - Supplementary Information: - - ONVIF Protocol: - - microservices/device/services/device-onvif-camera/supplementary-info/ONVIF-protocol.md - - microservices/device/services/device-onvif-camera/supplementary-info/onvif-user-authentication.md - - Features: - - microservices/device/services/device-onvif-camera/supplementary-info/custom-metadata-feature.md - - microservices/device/services/device-onvif-camera/supplementary-info/friendlyname-mac.md - - microservices/device/services/device-onvif-camera/supplementary-info/device-status.md - - microservices/device/services/device-onvif-camera/supplementary-info/auto-discovery.md - - microservices/device/services/device-onvif-camera/supplementary-info/credentials.md - - microservices/device/services/device-onvif-camera/supplementary-info/reboot-needed.md - - API Reference: - - microservices/device/services/device-onvif-camera/supplementary-info/api-analytic-support.md - - microservices/device/services/device-onvif-camera/supplementary-info/api-event-handling.md - - microservices/device/services/device-onvif-camera/supplementary-info/api-usage-user-handling.md - - Utility: - - microservices/device/services/device-onvif-camera/supplementary-info/test-with-postman.md - - microservices/device/services/device-onvif-camera/supplementary-info/utility-scripts.md - - Miscellaneous: - - microservices/device/services/device-onvif-camera/supplementary-info/control-plane-events.md - - microservices/device/services/device-onvif-camera/supplementary-info/getting-started-with-docker-security.md - - microservices/device/services/device-onvif-camera/supplementary-info/ws-discovery.md - - microservices/device/services/device-onvif-camera/supplementary-info/onvif-footnotes.md + - Device BacNet: microservices/device/services/device-bacnet.md + - Device COAP: microservices/device/services/device-coap.md + - Device GPIO: microservices/device/services/device-gpio.md + - Device ModBus: microservices/device/services/device-modbus.md + - Device MQTT: microservices/device/services/device-mqtt.md + - Device Onvif Camera: + - microservices/device/services/device-onvif-camera/General.md + - microservices/device/services/device-onvif-camera/swagger.md + - Walkthrough: + - microservices/device/services/device-onvif-camera/Walkthrough/setup.md + - microservices/device/services/device-onvif-camera/Walkthrough/deployment.md + - microservices/device/services/device-onvif-camera/Walkthrough/general-usage.md + - microservices/device/services/device-onvif-camera/Walkthrough/custom-build.md + - Supplementary Information: + - ONVIF Protocol: + - microservices/device/services/device-onvif-camera/supplementary-info/ONVIF-protocol.md + - microservices/device/services/device-onvif-camera/supplementary-info/onvif-user-authentication.md + - Features: + - microservices/device/services/device-onvif-camera/supplementary-info/custom-metadata-feature.md + - microservices/device/services/device-onvif-camera/supplementary-info/friendlyname-mac.md + - microservices/device/services/device-onvif-camera/supplementary-info/device-status.md + - microservices/device/services/device-onvif-camera/supplementary-info/auto-discovery.md + - microservices/device/services/device-onvif-camera/supplementary-info/credentials.md + - microservices/device/services/device-onvif-camera/supplementary-info/reboot-needed.md + - API Reference: + - microservices/device/services/device-onvif-camera/supplementary-info/api-analytic-support.md + - microservices/device/services/device-onvif-camera/supplementary-info/api-event-handling.md + - microservices/device/services/device-onvif-camera/supplementary-info/api-usage-user-handling.md + - Utility: + - microservices/device/services/device-onvif-camera/supplementary-info/test-with-postman.md + - microservices/device/services/device-onvif-camera/supplementary-info/utility-scripts.md + - Miscellaneous: + - microservices/device/services/device-onvif-camera/supplementary-info/control-plane-events.md + - microservices/device/services/device-onvif-camera/supplementary-info/getting-started-with-docker-security.md + - microservices/device/services/device-onvif-camera/supplementary-info/ws-discovery.md + - microservices/device/services/device-onvif-camera/supplementary-info/onvif-footnotes.md + - Device REST: microservices/device/services/device-rest.md + - Device RFID LLRP: microservices/device/services/device-rfid-llrp.md + - Device SNMP: microservices/device/services/device-snmp.md + - Device UART: microservices/device/services/device-uart.md - Device USB Camera: - microservices/device/services/device-usb-camera/General.md - Walkthrough: - - microservices/device/services/device-usb-camera/walkthrough/setup.md - - microservices/device/services/device-usb-camera/walkthrough/deployment.md - - microservices/device/services/device-usb-camera/walkthrough/general-usage.md - - microservices/device/services/device-usb-camera/walkthrough/custom-build.md + - microservices/device/services/device-usb-camera/walkthrough/setup.md + - microservices/device/services/device-usb-camera/walkthrough/deployment.md + - microservices/device/services/device-usb-camera/walkthrough/general-usage.md + - microservices/device/services/device-usb-camera/walkthrough/custom-build.md - Supplementary Information: - - microservices/device/services/device-usb-camera/supplementary-info/USB-protocol.md - - microservices/device/services/device-usb-camera/supplementary-info/discovery.md - - microservices/device/services/device-usb-camera/supplementary-info/advanced-options.md + - microservices/device/services/device-usb-camera/supplementary-info/USB-protocol.md + - microservices/device/services/device-usb-camera/supplementary-info/discovery.md + - microservices/device/services/device-usb-camera/supplementary-info/advanced-options.md - Device Virtual: microservices/device/services/device-virtual/Ch-VirtualDevice.md - V3 Migration: microservices/device/V3Migration.md - Application: