-
Notifications
You must be signed in to change notification settings - Fork 86
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix #23; update the microservices, core services, metadata page - wit… #193
fix #23; update the microservices, core services, metadata page - wit… #193
Conversation
…a page - with lots of new additions for device profile Signed-off-by: Jim White <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll approve this for now, but I don't love how much content about device services is in metadata. Can be restructured later i suppose.
The Metadata microservice has the knowledge about the devices and | ||
sensors and how to communicate with them that is used by the other | ||
services, such as Core Data, Command, and so forth. | ||
The core metadata micro service has the knowledge about the [devices](../../../general/Definitions.md#device) and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a note -- we inconsistenly write "micro service" and "microservice". Not sure which one is correct, its a nitpick but its back and forth all over the place :)
|
||
Device profiles define general characteristics about devices, the data they provide, and how to command them. Think of a device profile as a template of a type or classification of device. For example, a device profile for BACnet thermostats provides general characteristics for the types of data a BACnet thermostat sends, such as current temperature and humidity level. It also defines which types of commands or actions EdgeX can send to the BACnet thermostat. Examples might include actions that set the cooling or heating point. Device profiles are typically specified in YAML file and uploaded to EdgeX. More details are provided below. | ||
|
||
#### Device Profile Details |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am surprised how much information we have about devices and device profile in the metadata section. It seems to me this should provide a link over to devices services section and describe what goes into one over there. Yet, we're describing every piece of the device profile document in metadata. I think the relationship is necessary to describe here, but details about what makes up a profile doesn't seem appropriate here.
…adata Signed-off-by: edgex-jenkins <[email protected]>
…h lots of new additions for device profile
Signed-off-by: Jim White [email protected]
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
n/a
Issue Number:
#23
What has been updated?
The Metadata page in the micro services tab of the docs
Are there any specific instructions or things that should be known prior to reviewing?
none
Other information