Installing the IzoT CPM 4200 Wi-Fi SDK

Owned by Sacha Parisot (Unlicensed)
Last updated: 28-Sept-2022 by Nina Cardillo (Unlicensed)

You can install the Izot CPM 4200 Wi-Fi SDK on a Windows computer. The Wi-Fi SDK requires the following software:

  • Microsoft Windows 10 (64-bit or 32-bit), Windows 8.1 (64-bit or32-bit), Windows 8 (64-bit or32-bit), Windows 7 (64-bit or 32-bit), or Windows XP with SP3 (32-bit) versions
  • Eclipse Luna—this popular open-source integrated development environment (IDE) is included with the IzoT CPM 4200 Wi-Fi SDK
  • Java runtime environment (JRE)—this runtime environment is required by the Eclipse software, and you must have a compatible version installed prior to installing the IzoT CPM 4200 SDK as described at wiki.eclipse.org/Eclipse/Installation; if you are using a 64-bit version of Windows, Eclipse requires a 64-bit JRE

To install the IzoT CPM 4200 Wi-Fi SDK, install and configure the software listed below as described in the steps that follow.

  • Java Runtime Environment (JRE)
  • Izot Net Server
  • IzoT Commissioning Tool
  • Terminal emulator (optional)
  • WireShark network protocol analyzer (optional)
  • IzoT CPM SDK
  • FTDI D2XX Driver Update
  • LIBUSB Driver

The screen shots that follow and the associated instructions are for Windows 7. Other versions of Windows may differ in places. The instructions assume that you have installed in the default LonWorks application directory, which by default is C:\Program Files (x86)\LonWorks on 64-bit versions of Windows; if your LonWorks application directory is in a different location, adjust the directory to match yours.

The IzoT Net Server and the IzoT Commissioning Tool require activation. The IzoT CPM 4200 Wi-Fi EVK includes one IzoT Commissioning Tool Activation Key that is used by both products. The IzoT Commissioning Tool Activation Key is printed on the back of the IzoT Commissioning Tool EVK Edition DVD.

  1. If you do not have a compatible Java Runtime Environment (JRE) installed, download and install one from the following location:
    www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html

  2. Install the IzoT Net Server.

    1. Insert the IzoT Net Server CD included with the Wi-Fi EVK into your CD or DVD drive.

    2. If the installation does not start automatically, browse the CD and double-click the IzoTNetServer402.exe installation program.  Any previously installed version of an LNS or OpenLNS Server will be automatically uninstalled.

    3. Follow the instructions provided by the installation wizard. When you see the Customer Information window, enter the IzoT Commissioning Tool Activation Key printed on the back of the Commissioning Tool DVD. Under Echelon Account, enter the user name (e-mail address) and password for your Echelon download account if you have one.  Entering your Echelon download account will enable you to download software from the Echelon Web site; make activating and managing licenses for multiple Echelon products easier; enable you to return, transfer, and recover licenses; and help you receive technical support from Echelon faster. If you do not have an Echelon download account, you can create one here, or you can leave Echelon Account blank.

    4. Click Next.

    5. Click Install, and complete the instruction steps.

  3. Install the IzoT Commissioning Tool. Installing the IzoT Net Server on the same computer with the OpenLNS Commissioning Tool converts the OpenLNS Commissioning Tool to an IzoT Commissioning Tool. The product names referenced by the OpenLNS Server and the OpenLNS Commissioning Tool are not all updated to the new IzoT names by the IzoT Net Server. You will see references to both sets of names in the software and documentation.

    1. If you have not previously installed and activated the OpenLNS Commissioning Tool, insert the OpenLNS Commissioning Tool EVK Edition DVD included with the Wi-Fi EVK and install that now, entering the same IzoT Commissioning Tool Activation Key that you used for the IzoT Net Server installation.

    2. If you previously installed the OpenLNS Commissioning Tool Professional Edition, then you can continue to use it and skip to the next step. If you previously installed and activated the OpenLNS Commissioning Tool Standard Edition, use the Echelon License Wizard to return the OpenLNS Commissioning Tool Standard Edition license to your account and re-activate using the IzoT Commissioning Tool Activation Key used above. This will remove the network limit set by the Standard Edition Activation Key.
                                                                                                                                                                                                                                                                                                                                                                                                               

  4. Create a LonTalk/IP interface.

    1. Click the Windows Start button, open the Echelon IzoT Network Service Utilities folder, and then click LonTalk-IP Interfaces. The following dialog appears:



    2. Type a name such as LonTalk/IP in the LonTalk/IP Interfaces box. This will be the name you supply when specifying an interface to IzoT CT or NodeUtil.

    3. Select your LAN connection from the list of available IP interfaces.

    4. Click Create.

    5. Close the LonTalk/IP Interfaces application.

  5. Install a terminal emulator. A terminal emulator is optional, but is very useful for debugging the Wi-Fi EVB. If you do not already have a terminal emulator installed on your computer, then you can obtain one for free such as PuTTY.  You can download PuTTY from www.chiark.greenend.org.uk/~sgtatham/putty/download.html. Your chosen terminal emulator program must support serial communication using a standard (virtual) COM port at 115200 baud (8N1, no handshake).

  6. Install the WireShark network protocol analyzer. Wireshark is optional, but is very useful for network traffic analysis.  

    1. If you do not already have WireShark installed, download a free from www.wireshark.org/download.html and install it.

    2. Close the Wireshark tool if it is running.

    3. Copy lontalkip.dll from C:\Program Files (x86)\LonWorks\WireShark\LonTalkIp Plugin to your Wireshark plugins directory while Wireshark is not running. In a typical installation, this will be C:\Program Files\Wireshark\plugins\1.12.1, where 1.12.1 is your version of WireShark. The distribution includes the plug-in compiled for both 32-bit and 64-bit versions of Windows. Use the one appropriate to your Windows installation.

  7. Install the IzoT CPM 4200 Wi-Fi SDK. Download the IzoT CPM SDK from https://downloads.echelon.com/support/downloads/izot/wifi/1.00.18/izot-cpm-4200-sdk.exe and run the izot-cpm-4200-sdk.exe installation program.  Follow the instructions provided by the installation wizard.

  8. Install the FTDI D2XX Driver Update.

    1. Disconnect one of the Wi-Fi EVBs from your computer, leaving one connected to your computer via the supplied USB A to USB Micro B cable connected to the lower port of the Wi-Fi EVB as shown.



    2. Open Windows Update, and click Check for Updates and wait for this to complete.

    3. Click Optional Updates, and look for an update called FTDI – Other hardware – USB Serial Converter B update as shown below. Select only the FTDI – Other hardware – USB Serial Converter B and then click OK.



    4. Click Important Updates (if shown) and clear all the updates so that only the FTDI update will be installed. Click OK.

    5. Click Install Updates, once complete, close any other open applications that may be running after saving your data. Click Restart Now when prompted as shown below. If no updates were available, then proceed to step 7f below.



    6. Open the Device Manager from your Control Panel, it should show two USB ports as follows (but not necessarily with the same COM port numbers as shown).



    7. Right click one of the USB ports, select Properties, click the Driver tab and verify that the Driver Version is 2.10.0 or greater. Click OK.

    8. If the driver is not 2.10.0 or greater, download CDM v2.12.00 WHQL Certified.zip (or the latest version) from www.ftdichip.com/Drivers/D2XX.htm, uncompress it to a suitable location and run the relevant installer for your computer. The installer filename is dpinst-x86.exe for 32-bit Windows installations or dpinst-amd64.exe for 64-bit Windows installations (this may take some time to complete). Install the FTDI D2XX Driver Update.

  9. Install the LIBUSB Driver.

    1. Open the C:\Program Files (x86)\LonWorks\cpmsdk\cpm4200\libusb\libusb-win32-bin-1.2.6.0\bin folder in Windows Explorer and run inf-wizard.exe. The following dialog appears:



    2. Click Next. The following dialog appears:



    3. Select the Dual RS232 (Interface 0) interface. Click Next and the following dialog appears:



    4. Click Next and the following dialog appears prompting you to save the Dual_RS232_(Interface_0).inf file:



    5. Choose a suitable location and click Save. You will not need to reference the saved file again. The following dialog appears:



    6. Click Install Now and the following dialog appears:



    7. Click Yes.

    8. Click Install this Driver Software Anyway. The following dialog appears:



    9. Click OK. Device Manager should now show a Dual RS232 (Interface 0), a USB Serial Port, and a USB Serial Converter as shown below. Make a note of the USB Serial Port, shown as COM5 in the example that follows.



    10. If the FTDI D2XX driver is updated either by Windows Update or manually, you will have to reinstall the LIBUSB driver as described above.


  10. Set up a terminal emulator session.

    1. With the Wi-Fi EVB still connected, Start PuTTY or a similar terminal emulator package.



    2. Select a 115200 bps serial port. For PuTTY, select Serial, specify the Serial Line as noted previously, and set the speed to 115200 bps (8N1, no handshake).

    3. You should see a blank console window; any form of running application will have serial communications. You will return to the terminal emulator later.



  11. Start the IzoT CPM 4200 Programming Tools.

    1. Start the Echelon IzoT CPM Programming Tools from within the Echelon IzoT CPM SDK program folder. The following window appears:



    2. Close the Welcome tab.

    3. If the programming tools fail to launch with errors relating to the Java runtime environment, such as the following:



      Ensure that you have the correct JRE installed and configured as described above. You can find more information on Eclipse JRE requirements here. Once the JRE configuration is addressed, start Echelon IzoT CPM Programming Tools again, closing the Welcome window once launched.


  12. Set up OpenOCD as an external tool in Eclipse. You only have to do this once as the configuration will be available to all your projects.  The CPM SDK uses the open-source Open On-chip Debugger (OpenOCD) to provide a debug interface, connecting the Wi-Fi EVK or custom hardware via USB to the C or C++ source code debugger in Eclipse. To use OpenOCD, users of the IzoT CPM 4200 Wi-Fi EVK Beta release must configure OpenOCD as an Eclipse external tool.

    1. From the Eclipse main menu, select Run → External Tools → External Tools Configuration. The following dialog appears:



    2. Right-click Program and the select New from the shortcut menu. The following dialog appears:



    3. The following dialog appears:



    4. Enter the name of the configuration in the Name box, for example, OpenOCD.

    5. Enter the following value in Location:

      ${env_var:CPM_SDK_HOME}\cpm4200\OpenOCD\bin\windows\openocd.exe

    6. Enter the following value in Working Directory:

      ${env_var:CPM_SDK_HOME}\cpm4200\OpenOCD

    7. Enter the following value in Arguments:

      -s interface -f ftdi.cfg -f openocd.cfg -c init

    8. Click Apply to save the configuration.

    9. Select the Build tab.



    10. Ensure that that Build Before Launch is not selected. Click Apply to save the changes.

    11. Select the Common tab.



    12. Ensure that Local File is selected and that External Tools is selected in Display in Favorites. Ensure that Launch in Background is selected. Click Apply to save the configuration.

    13. With the Wi-Fi EVB still connected, click Run to start the OpenOCD connection and you should see the following (the OpenOCD version may be different), confirming the connection was established correctly (you can ignore the Interface Already Configured warning and the Already Specified FT232_layout jtagkey error):



    14. However, should you see an Unable to Open FTDI Device: Device Not Found error, you have a configuration issue. Ensure the Wi-Fi EVB is connected to your computer and re-run the LIBUSB Driver Installation procedure. Click Run and select External Tools → External Tools Configuration.Click Run to try the OpenOCD connection again. When you subsequently start the IzoT CPM Programming Tools, connect your Wi-Fi EVB and you can now start the OpenOCD connection from the external tools configuration you have just established.



  13. Configure Eclipse to save modified files automatically before building. In Window → Preferences → General → Workspace, ensure that Save Automatically before Build is selected. Click OK to save the changes.



  14. Set up a Wi-Fi module project.

    1. From the Eclipse main menu, select File → New Project:



      In subsequent references to File → New, you will see the following:



    2. Expand C/C++ and select IzoT C/C++ CPM Project.
       

    3. Click Next. The following dialog appears:



    4. Enter a project name (project names cannot have spaces), select New CPM 4200 Project, and then click Next. The following dialog appears:



    5. Click Next. The following dialog appears:



    6. Click Finish. The following dialog appears:



    7. Select Remember my Decision, and then click Yes. You will now have a new project set up with the following skeleton code:



  15. Build the Wi-Fi module project: right click your project in the Eclipse Project Explorer and select Build Project.

  16. Explore the default project created by the New IzoT C/C++ Project wizard. The default project includes the following:

    • The main C source file, sharing the name with the project name. This file includes the standard C main() function and entry point.  Do not rename this file. This file does not need to contain your application's main() entry point, but it does contain your application's IzoT interface definitions. For a new project, this file contains a simple application skeleton including a simple example Node Object block implementation and a skeleton main() function for your application.

    • A pair of IzoTDev.h and IzoTDev.c files, initially empty. When you build the application, the CPM SDK build tools inspect your main C source file for IzoT Markup Language definitions, and generates all declarations and code required in these two files. You can inspect these files, but don't edit them because the tool overwrites them when you build your application.

    • A pre-configured set of include files and link libraries to provide access to the IzoT Device Stack DX and the runtime system.