To help OEM Equipment Firmware Developers start an integration with Open Kitchen, this article provides high level process step to connect equipment to Open Kitchen. While additional information can always be found on our PhD Technical Public Documentation, starting here can help the process go smoothly.
Understand the big picture of Connected Equipment in the Open Kitchen Environment
Notify Powerhouse Dynamics that you would like to begin the integration process
Complete the https://sitesage.atlassian.net/wiki/x/CYD7Ig and email to connectware@powerhousedynamics.com
Get access to the ConnectWare Library repository
As detailed in the https://sitesage.atlassian.net/wiki/x/IQBCHQ, request ConnectWare GIT repository access by emailing connectware@powerhousedynamics.com
Study Open Kitchen and ConnectWare Documentation
Open Kitchen ConnectWare API User Guide
OpenKitchen ConnectWare Serial Protocol Specification
Open Kitchen Message Specification
https://sitesage.atlassian.net/wiki/x/AwBXFg
Request Sensor family and model IDs
https://sitesage.atlassian.net/wiki/x/A4BwEQ
If not already provided by the integration survey, request a sensor family and Model ID for your product(s) by emailing connectware@powerhousedynamics.com with the following information
Partner Brand Name
Equipment model family
Equipment model name
Company logo
Equipment image
Create and Submit an equipment Data Dictionary
Use the attached Data Dictionary Specification template to build a Data Dictionary and submit it to connectware@powerhousedynamics.com
Work with PhD team to validate the Data Dictionary
Port ConnectWare Library to Equipment Controller
See Porting to integrate the ConnectWare Library code into the equipment controller
Test and Verify communications and functionality using software simulators
https://sitesage.atlassian.net/wiki/x/FYBWHQ https://sitesage.atlassian.net/wiki/x/GgBXHQ
Prior to connecting to the real cloud, use the simulators provided in the GIT repository to verify communications between the equipment and the Open Kitchen Cloud will be successful.
Validate with PhD and begin cloud communications
Work with PhD team to validate connectivity and Data Dictionary