DRAFT - Early Program Documentation - DRAFT
Description
...
**Draft**
Announcement
With the Hanoi release, EdgeX Foundry announces the availability of EdgeX Ready.
What It Is
The EdgeX Ready program is about demonstrating the ability to work with EdgeX. The designation helps other community participants and solution vendors identify vendors who have gone through a self-assessment process to demonstrate that they are able to integrate one of their offerings with solutions using EdgeX. Those vendors who have joined the program are highlighted on the EdgeX Foundry website with an EdgeX Ready badge next to their logo.
The initial, “crawl,” phase of the “self-assessment process” is to simply validate a device profile. Users attest that they have authored a device profile and can get moved device-specific data moving through an EdgeX instance that they had set up themselves thereby demonstrating some familiarity with EdgeX and, more specifically, of device services and their associated device profiles. Upon submission and approval of their device profiles and sample data, users receive a badge identifying their accomplishment, which they can utilize in their marketing and promotional materials. The goal of the program is to provide awareness of users and their organizations that have EdgeX expertise while also promoting the sharing of EdgeX device connectivity elements (e.g. device profiles and the like), and sample data sets to accelerate adoption of the platform.
We've done several things in the Hanoi release to help users succeed at this task:
- In our documentation, you will now find a specification for device profiles (see: Device Profile Reference). For those who prefer reading the code to infer the specification, you can still do that, too! Start here with our Getting Started - Developers guide or hop right to the EdgeX Foundry Project on GitHub.
- We will soon provide a tool with which users can validate the syntax of their device profile2.
- Furthermore, we have provided cloud-specific templates and how-to guides for instantiating a reference implementation of EdgeX in the cloud to minimize the domain knowledge required outside of the immediate device service and their associated IoT protocol. With these cloud EdgeX instance, users can verify that their device profile and sample data achieves the desired form within EdgeX. See our Examples Repository for both Azure and AWS cloud templates.
We the users’ logos will be badged on the EdgeX Foundry website.
We are initially launching with MQTT- and REST-based device servicesprofiles. This is just the beginning. With community interest, we will expand the program to support additional device services.
If you would like to be among the first to go through this program, we would love to hear from you! You can reach us at
| Status | ||||
|---|---|---|---|---|
|
Participation in the EdgeX Ready program requires that one is an EdgeX User. For more information about EdgeX User and how to become one, please see the following
| Status | ||||
|---|---|---|---|---|
|
1 Program name has not yet been finalized. EdgeX Ready is a placeholder program name.
2 Your device profile must pass validation using this tool to be considered in the EdgeX Ready program
Availability
EdgeX Ready will be announced before the end of 2021.
Feedback
We are interested in hearing from you! If you have thoughts you would like to share, about this program, or perhaps of expanding this program to address additional IoT protocols offered by our other device services that align better with your interests, you can find us at
| Status | ||||
|---|---|---|---|---|
|
EdgeX Ready Workflow
...
Self-Assessment Process
We ask the vendors to do the following:
- Instantiate an instance of the reference implementation of EdgeX with their device profile
Using a device that is described by their device profile, generate sample data, and send it to the appropriate device service
- Confirm that the data arrives in Core Data
- Validate their device profile using one of the tools provided by the Certification WG
- Submit their validated device profile and sample data to the EdgeX Ready program
This workflow diagram below may help with understanding the process:
Device Profile Validators
[TBD]
Required Public Materials
The following materials are required to included in the EdgeX Ready Program submission:
- Participation Form – PDF (.pdf), Word document (.docx), possibly Open Document Format (ODF) Text Document (.odt)
- Device Profile – YAML (.yaml)
- Associated sample data – JSON (.json)
- Sample data schema – JSON (.json)
- (Optional) UUID of the device profile, if validated using IOTech's DCT website, in the form of 123e4567-e89b-12d3-a456-426614174000
Contributions
We at the EdgeX Foundry are very much interested in providing the EdgeX community with multiple options for validating device profiles for the EdgeX Ready Program. If you have your own EdgeX validator and would like to contribute the implementation as open-source or share the service with the EdgeX community and the EdgeX Ready program specifically, we are interested in hearing from you! Please reach out to us on Slack at #edgex-ready, email us at edgex-ready@edgexfoundry.org, or contact the Certification Team WG Chair directly at rodney@beechwoods.com and we can discuss next steps.
Availability
EdgeX Ready will be announced before the end of 2021.
FAQ
What does it cost to be EdgeX Ready?
...