Equipment Firmware Development Process Outline

$ git clone https://github.com/Powerhouse-Dynamics/connectware

Cloning into 'connectware'...

remote: Counting objects: 538, done.

Remote: Compressing objects: 100% (517/517), done.

Remote: Total 538 (delta 312), reused 0 (delta 0)

Receiving objects: 100% (538/538), 43.18 MiB | 631.00 KiB/s, done.

Resolving deltas: 100% (312/312), done.

$ cd connectware/

$ git tag

1.0.0

1.0.1

….

1.0.15

1.0.16

$ git checkout -b 1.0.16 1.0.16

Switched to a new branch '1.0.16'

OKE implementors should use the latest tagged version.

This document contains detailed release notes for each tagged version and information about upgrading from earlier versions to the newer versions.

From the ./lib directory:

cwassert.h, cwcrc16.c, cwcrc16.h, cwdll.c, cwdll.h, cwnwk.c, cwnwk.h, mjson.c, mjson.h, cwver.h

From the ./_OpenKitchenEquipment_OKE directory:

cwcmd.c, cwcmd.h, cwmsg.c, cwmsg.h

Implementors should not modify any of these files.

From either the ./_OpenKitchenEquipment_OKE/ports/windows or ./_OpenKitchenEquipment_OKE/ports/linux directory copy the following files:

cwport.c, cwport.h, cwmsgsel.h, and optionally strlcpy.c if your platform does not natively support strlcpy().

main.c is example startup code.

Embedded platforms will start their port using either the Windows or Linux port as a baseline.

Carefully read the integration instructions contained in cwport.c and cwport.h Begin embedded controller integration by commenting out much of the functions in these two files until the code compiles. Then modify to work on your controller.

For the initial port, it is recommended to set CW_PORT_INVALID_OKM_HARD_ERROR to 1 and CW_PORT_IS_FILE_SUPPORT_ENABLED to 0 in cwport.h. This will minimize the number of functions that must be implemented to get the first port working.

It is strongly recommended that MJUnitTest() is run to verify that the JSON library is working correctly on the target platform.

Call CWPortInitTask(), and then from the main loop or dedicated task/thread periodically call CWPortRunTask().

Refer to ./_OpenKitchenEquipment_OKE/ports/windows/main.c for an example of how to initialize and call the ConnectWare Library from your main() function.

See CWL Task for a detailed explanation of how to properly invoke CWPortInitTask() and CWPortRunTask().

Connect the controller to a serial port on a Windows PC. Run the cwm.exe and okc.exe programs included with the CWL sources.

The simulated CWM and OKC allow you to test the port running on the controller.

See https://sitesage.atlassian.net/wiki/x/FYBWHQ for instructions on using the simulators.