Series 5000 Tools Update 2 ReadMe
March 2011
Copyright
© 2011 Echelon Corporation
All Rights Reserved
If you are using the Echelon series 5000 chips in production devices, and use the SCI I/O model on those devices, you should apply this update to your development tools, and then follow the usage instructions to ensure a reliable SCI I/O data stream. No other devices that use SCI I/O are affected.
Affected tools include:
1. NodeBuilder FX Development Tool – versions through Service Release 1 (4.01)
2. Mini FX Evaluation Kit – versions through Service Release 1 (4.01)
You should first determine the version number of your NodeBuilder or Mini product. This can be determined by looking at the About box for either product, accessible from the Help menu item on the main product menu.
The NodeBuilder version number should be 4.01.07. If it is 4.00.32, you should contact Echelon customer support to get a free upgrade to 4.01 (also known as NodeBuilder FX, SR1) before applying this update. If it is less than 4.00, this update may not be applied, as Echelon “FX” level development tools are required in order to work with series 5000 chips. If the version number is higher than 4.01.07, this update should not be applied either, as it will be incorporated in later versions of the product.
After confirming that you have the correct version of the product to apply the update, you should determine the location of your LonWorks directory. This directory is used as a central location for installing all Echelon LonWorks software. Depending on when you first installed Echelon LonWorks software, this directory would default to either C:\LonWorks or C:\Program Files\LonWorks, but could also be set to another value by the user. If NodeBuilder or Mini is installed, you will see sub-directories under the LonWorks directory entitled NodeBuilder and MiniKit, respectively. You can also find the location of the LonWorks directory in the Windows Registry at HKEY_LOCAL_MACHINE\Software\LonWorks\LonWorks Path.
The Series5000ToolsUpdate2.zip file contains three files: Series5000ToolsUpdate2_ReadMe.htm, gen.lib and echelon.h.
After finding the LonWorks directory, navigate to the Images directory one level below it. In that directory, you will find a file named gen.lib. Copy it to a safe place, and then replace it with the copy of this file found in the Series5000ToolsUpdate2.zip file.
Now, navigate to the NeuronC\Include directory at the level below the LonWorks directory. In that directory, you will find a file named echelon.h. Copy it to a safe place, and then replace it with the copy of this file found in the Series5000ToolsUpdate2.zip file.
After applying the update, you can safely use the SCI I/O on series 5000 chips, without data loss. For that chip family only, instead of calling the routine io_in_request() for the SCI I/O model, you should call sci_in_request_ex(), defined in echelon.h, with the buffer pointer as the first parameter and the buffer size as the second.
If either NodeBuilder or Mini is installed after this update is applied, the update will need to be reapplied, because the two files will be overwritten. Note that releases of NodeBuilder and Mini which have higher version numbers than the releases specified as candidates for this update will already have the fixes incorporated, and will no longer require this patch.
If either the NodeBuilder or Mini installation is repaired through the Windows Control Panel Add/Remove Programs Repair button, the update will need to be reapplied, because the two files will be overwritten.