Introduction

The OpenKitchen vision is to connect all kitchen equipment simply, securely, and reliably to a unified cloud in an open and extensible manner.

The ConnectWare Library (CWL), documented in this User Guide, allows equipment manufacturers to easily implement OpenKitchen compatibility on their platforms.

This User Guide is primarily intended for embedded software and firmware developers porting and using the CWL. Some business managers and many engineering managers may find parts of the document helpful in understanding the scope of requirements necessary for porting the CWL and implementing OpenKitchen compatibility.

OpenKitchen Messages

OpenKitchen exclusively encodes messages using a common, extensible, plain-text, platform-neutral, structured format called JSON, pronounced as "Jason". For example, an oven may report the following JSON data to OpenKitchen:

The primary role of the CWL is to pass JSON messages between the equipment and the cloud.

The primary role of developers using the CWL is to create these JSON messages and sometimes process them.

Equipment manufacturers have tremendous flexibility to encode information using JSON.

The cloud uses a data dictionary, provided by the equipment manufacturer, to decode the information.

ConnectWare Module

In OpenKitchen, the ConnectWare Module (CWM) is the network interface that connects equipment to the cloud. Equipment interfaces to the CWM using a serial interface. The CWM deals with network connectivity and has options for WiFi, Cellular, and MiWi. Because of the modular interface, end-users can select the most appropriate network interface for their environment. In most cases equipment will be totally insulated from nearly all network connectivity issues. In the worst-case equipment may be involved with initial network setup, for example selecting a WiFi network and providing the password. Beyond this the equipment controller does not need to be concerned about network connectivity since it is completely handled by the CWM.

Open

ConnectWare Library

The CWL is delivered as C source code that will easily port to any platform. Equipment will run the CWL on its controller and implement equipment specific OpenKitchen messages in JSON.

ConnectWare Library Core Files

Located in the connectware\lib folder, there are 10 .c and .h files that are common to all ConnectWare and OpenKitchen endpoints

Open

These files are maintained by Powerhouse Dynamics as part of the CWL and should not be modified by the integration.

ConnectWare Library Equipment Side Port Specific Files

Located in the \connectware\_OpenKitchenEquipment_OKE, there are 4 .c and .h files that are specific to the Equipment side integration.

These files are maintained by Powerhouse Dynamics as part of the CWL and should not be modified by the integration.

Open

ConnectWare Library Equipment Side Port Specific API Files

Located in the \connectware\_OpenKitchenEquipment_OKE\ports 4-5 .c and .h files that are specific to the Equipment side integration.

Open

Specifically, the cwport.c/.h files should be modified to adapt to the specific embedded system integration. See https://sitesage.atlassian.net/wiki/x/IQBCHQ for details.