Serial to WiFi Adapter Guide
GainSpan GS1011MEx/GS1500M Single Site Programmer User’s Guide
Version: 1.0 Date: July 18, 2014
SINGLE SITE PROGRAMMER QUICK START GUIDE
Version
Date
1.0
18 July 2014
Remarks Initial release.
Copyright © 2014 by GainSpan Corporation All rights reserved. GainSpan Corporation +1 (408) 627-6500 [email protected] www.GainSpan.com GainSpan and GainSpan logo are trademarks or registered trademarks of GainSpan Corporation. Specifications, features, and availability are subject to change without notice.
1 PRELIMINARY
PAGE 2 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
Table of Contents 1
PURPOSE............................................................................................................................................. 5
2
SCOPE .................................................................................................................................................. 6
3
SINGLE SITE PROGRAMMER ....................................................................................................... 7 3.1
4
HARDWARE SETUP AND INSTALLATION .............................................................................. 10 4.1
5
INSTALLING THE SINGLE SITE PROGRAMMER SOFTWARE ........................................................... 13 THE GUI ....................................................................................................................................... 13 USING THE CONFIGURATION FILE ................................................................................................. 15
RUNNING THE GUI ........................................................................................................................ 16 6.1 6.2
7
POPULATING THE SITE .................................................................................................................. 11
SOFTWARE TEST SETUP AND REQUIREMENTS .................................................................. 13 5.1 5.2 5.3
6
HARDWARE AND DESCRIPTION ...................................................................................................... 7
NOTES ........................................................................................................................................... 17 CAUTION: ...................................................................................................................................... 18
APPENDIX A ..................................................................................................................................... 19
Tables Table 1 Hardware components ..................................................................................................................... 8 Table 2. SW segments................................................................................................................................. 14 Table 3. Configuration file settings............................................................................................................. 15
1 PRELIMINARY
PAGE 3 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
Figures Figure 1. GainSpan module with product label and MAC ID ...................................................................... 6 Figure 2. Single Site Programmer HW ......................................................................................................... 7 Figure 3. Single Site Programmer board. ...................................................................................................... 9 Figure 4. Hardware setup ............................................................................................................................ 10 Figure 5. Populating the site. ...................................................................................................................... 11 Figure 6. With cover closed and toggle clamp engaged. ............................................................................ 12 Figure 7. The GUI ....................................................................................................................................... 13 Figure 8. GUI Segments ............................................................................................................................. 14 Figure 9. Single Site Programmer configuration file .................................................................................. 15 Figure 10. SW in Programming Mode ........................................................................................................ 16 Figure 11. Loading firmwares ..................................................................................................................... 17 Figure 12. Firmware loading Successful..................................................................................................... 17
1 PRELIMINARY
PAGE 4 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
1 Purpose
T
his document is intended to describe in detail the flow of the GS Single Site Programmer program and hardware setup. This HW fixture and SW can be used to load firmware onto the GS1011MEx and GS1500M modules. SW installation and HW setup have to be strictly followed to ensure correct loading.
1 PRELIMINARY
PAGE 5 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
2 Scope The GainSpan Single Site Programming HW and SW enables the user to program one module at a time. This program will NOT erase the MAC ID stored in the factory default area. The MAC ID stored in each module will correspond to the MAC ID printed on the product label on top of the module.
Figure 1. GainSpan module with product label and MAC ID
1 PRELIMINARY
PAGE 6 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
3 Single Site Programmer 3.1 Hardware and Description The Single Site Programmer hardware, shown in Figure 2, and related components include: 1.) PC with Windows XP SP2/SP3 or Windows 7 2.) Bar code ccanner (Optional) 3.) DB9 Null Modem cable(s) 4.) USB-Serial cable(s) (optional depending on requirement. Prolific USB-Serial recommended) 5.) 3.3V DC Supply 6.) Module(s) to be programmed.
Figure 2. Single Site Programmer HW
1 PRELIMINARY
PAGE 7 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
Listed below are the components present on the fixture. Refer Figure 3. Table 1 Hardware components Item
Component
Description/Use
1
Single Site Programmer board
Program one module at a time.
2
Site
A single pogo pin fixture to hold the GS module.
3
DB9/UART connector
To connect a DB9 Null Modem cable to the PC.
4
Toggle clamp with cover
Should be pressed over the cover to ensure proper pin contact on the modules.
5
DC Power Jack
Provide 3.3V DC to power up the board.
6
ON/OFF Switch
To power up the board.
7
Program/Run Switch
To be set to Program mode always.
1 PRELIMINARY
PAGE 8 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
4
1
5
3
7 6
2
Figure 3. Single Site Programmer board. The software will produce undesirable results if any of the hardware setup is missing or not installed properly.
1 PRELIMINARY
PAGE 9 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
4 Hardware Setup and Installation Each Single Site Programmer board consists of single pogo pin fixture. A sample board is shown in Figure 2. The programmer HW site has its own DB9 connector through which the program can access the module and program it.
To PC DB9 connector
To 3.3V Power supply
Figure 4. Hardware setup
1 PRELIMINARY
PAGE 10 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
The board requires a 3.3V supply to power HW. The RUN/PROGRAM switch should be set to PROGRAM when programming and in RUN mode when performing QA. The hardware setup is shown in Figure 4.
4.1 Populating the site Before populating the site the operator must power off the board; every time. The GS1011/GS1500 modules need to be mounted with the logo/product label facing up and the module pins aligned with the pogo pins. Press down gently to ensure the module lays flat on the pogo pin fixture. Once the module is loaded, close the cover gently and engage the toggle clamp all the way to ensure there is even pressure on the site to make good pin contact (Figure 5 & 6)
Figure 5. Populating the site.
1 PRELIMINARY
PAGE 11 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
Figure 6. With cover closed and toggle clamp engaged.
1 PRELIMINARY
PAGE 12 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
5 Software Test Setup and Requirements The list of compatible software required to run the test includes: 1.) Windows XP SP2/SP3 or Windows 7 2.) LabVIEW runtime engine 2009 or later (provided with installation package) 3.) Single Site Programmer application 4.) Prolific USB-Serial Drivers 5.) Bar code Scanner drivers (if required)
5.1 Installing the Single Site Programmer software From the Single Site Programmer\Volume folder, run setup.exe. Follow the prompts to install the software. Restart the PC, if required. Upon successful installation, you should discover the Single Site Programmer 1p0 under Start>Single Site Programmer. User may launch the application from here or from \ Single Site Programmer folder.
5.2 The GUI Launch the Single Site Programmer 1p0.exe GUI. If the installation was successful, the user should see the GUI in Figure 7.
Figure 7. The GUI
1 PRELIMINARY
PAGE 13 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
9 1 8
6 2 7
3
4
5
Figure 8. GUI Segments The various segments of the GUI are listed below. Table 2. SW segments Item
Segment
Description/Use
1
COM Port
COM port to which the Single Site Programmer is hooked up to.
2
Status
Shows the current status of the program and intimates user.
3
WLAN
The WLAN firmware currently being loaded.
4
APP0
The APP0 firmware currently being loaded.
5
APP1
The APP1 firmware currently being loaded.
6
MAC ID
MAC ID of the module
7
Progress
Displays each step of the programming/QA process
8
MAC ID OK?
Green if MAC ID is valid, red otherwise.
9
Code Loaded? Green if WLAN, APP0 and APP1 are loaded successfully.
1 PRELIMINARY
PAGE 14 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
5.3 Using the configuration file A configuration file is provided with the SW to control the program flow. Open the Single Site Programmer.ini file using Notepad(Figure 9). Listed below are the fields and options.
Figure 9. Single Site Programmer configuration file Table 3. Configuration file settings Item
Name
Description/Options
1
COM Port
COM port to which the Single Site Programmer is hooked up to.
2
WLAN FW File name of WLAN Firmware
3
APP0
The APP0 firmware currently being loaded.
4
APP1
The APP1 firmware currently being loaded.
1 PRELIMINARY
PAGE 15 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
6 Running the GUI In order to run the SW in PROGRAM MODE, follow these steps. 1) Open the Single Site Programmer.ini file. Provide the correct WLAN, APP0 and APP1 file names and place all the three files in the same folder as the program. Enter the COM Port to which the HW is connected to. 2) Save and close the Single Site Programmer.ini file. 3)
Open the Single Site Programmer.exe (Figure 10).
Figure 10. SW in Programming Mode 4)
The Status box should display “PROGRAMMING MODE. Check if board is in PROGRAM MODE. HIT SPACE TO BEGIN”. If not, close the program and re-edit the configuration file(step 1).
5)
Ensure the Power Switch is OFF. Load the module, toggle the RUN/PROGRAM switch to PROGRAM.
6)
Switch the power to ON position and hit space.
7)
The program will begin loading the firmwares (Figure 11).
1 PRELIMINARY
PAGE 16 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
Figure 11. Loading firmwares 8)
If the loading was successful the MAC ID OK? and Code Loaded? indicators will turn bright green (Figure 12). If the loading was unsuccessful toggle power and repeat from Step 5.
Figure 12. Firmware loading Successful 9)
Load another module and repeat from Step 6.
6.1 Notes 1.
2.
If the progress dialog does not update or if the program stops responding for any reason, please close the Single Site Programmer 1p0.exe and re-launch. Ensure correct settings in Single Site Programmer.ini file. Incorrect settings will result in program to hang or crash.
1 PRELIMINARY
PAGE 17 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
6.2 Caution: Care has to be taken while closing the cover of the hardware. Excessive force will result in modules getting damaged and reduced lifetime of the hardware.
1 PRELIMINARY
PAGE 18 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
7 Appendix A List of items and description Item
Description
Picture
Test fixture
To load and program modules
Null modem cable
Connect between USB-Hub and DB9 connector on fixture.
Handy Vac
To lift and place modules.
3.3V Power Supply
To power up the test fixture and modules.
Power plug adapters
To use in different countries
1 PRELIMINARY
PAGE 19 OF 19
Version: 1.0 Date: July 18, 2014
SINGLE SITE PROGRAMMER QUICK START GUIDE
Version
Date
1.0
18 July 2014
Remarks Initial release.
Copyright © 2014 by GainSpan Corporation All rights reserved. GainSpan Corporation +1 (408) 627-6500 [email protected] www.GainSpan.com GainSpan and GainSpan logo are trademarks or registered trademarks of GainSpan Corporation. Specifications, features, and availability are subject to change without notice.
1 PRELIMINARY
PAGE 2 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
Table of Contents 1
PURPOSE............................................................................................................................................. 5
2
SCOPE .................................................................................................................................................. 6
3
SINGLE SITE PROGRAMMER ....................................................................................................... 7 3.1
4
HARDWARE SETUP AND INSTALLATION .............................................................................. 10 4.1
5
INSTALLING THE SINGLE SITE PROGRAMMER SOFTWARE ........................................................... 13 THE GUI ....................................................................................................................................... 13 USING THE CONFIGURATION FILE ................................................................................................. 15
RUNNING THE GUI ........................................................................................................................ 16 6.1 6.2
7
POPULATING THE SITE .................................................................................................................. 11
SOFTWARE TEST SETUP AND REQUIREMENTS .................................................................. 13 5.1 5.2 5.3
6
HARDWARE AND DESCRIPTION ...................................................................................................... 7
NOTES ........................................................................................................................................... 17 CAUTION: ...................................................................................................................................... 18
APPENDIX A ..................................................................................................................................... 19
Tables Table 1 Hardware components ..................................................................................................................... 8 Table 2. SW segments................................................................................................................................. 14 Table 3. Configuration file settings............................................................................................................. 15
1 PRELIMINARY
PAGE 3 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
Figures Figure 1. GainSpan module with product label and MAC ID ...................................................................... 6 Figure 2. Single Site Programmer HW ......................................................................................................... 7 Figure 3. Single Site Programmer board. ...................................................................................................... 9 Figure 4. Hardware setup ............................................................................................................................ 10 Figure 5. Populating the site. ...................................................................................................................... 11 Figure 6. With cover closed and toggle clamp engaged. ............................................................................ 12 Figure 7. The GUI ....................................................................................................................................... 13 Figure 8. GUI Segments ............................................................................................................................. 14 Figure 9. Single Site Programmer configuration file .................................................................................. 15 Figure 10. SW in Programming Mode ........................................................................................................ 16 Figure 11. Loading firmwares ..................................................................................................................... 17 Figure 12. Firmware loading Successful..................................................................................................... 17
1 PRELIMINARY
PAGE 4 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
1 Purpose
T
his document is intended to describe in detail the flow of the GS Single Site Programmer program and hardware setup. This HW fixture and SW can be used to load firmware onto the GS1011MEx and GS1500M modules. SW installation and HW setup have to be strictly followed to ensure correct loading.
1 PRELIMINARY
PAGE 5 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
2 Scope The GainSpan Single Site Programming HW and SW enables the user to program one module at a time. This program will NOT erase the MAC ID stored in the factory default area. The MAC ID stored in each module will correspond to the MAC ID printed on the product label on top of the module.
Figure 1. GainSpan module with product label and MAC ID
1 PRELIMINARY
PAGE 6 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
3 Single Site Programmer 3.1 Hardware and Description The Single Site Programmer hardware, shown in Figure 2, and related components include: 1.) PC with Windows XP SP2/SP3 or Windows 7 2.) Bar code ccanner (Optional) 3.) DB9 Null Modem cable(s) 4.) USB-Serial cable(s) (optional depending on requirement. Prolific USB-Serial recommended) 5.) 3.3V DC Supply 6.) Module(s) to be programmed.
Figure 2. Single Site Programmer HW
1 PRELIMINARY
PAGE 7 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
Listed below are the components present on the fixture. Refer Figure 3. Table 1 Hardware components Item
Component
Description/Use
1
Single Site Programmer board
Program one module at a time.
2
Site
A single pogo pin fixture to hold the GS module.
3
DB9/UART connector
To connect a DB9 Null Modem cable to the PC.
4
Toggle clamp with cover
Should be pressed over the cover to ensure proper pin contact on the modules.
5
DC Power Jack
Provide 3.3V DC to power up the board.
6
ON/OFF Switch
To power up the board.
7
Program/Run Switch
To be set to Program mode always.
1 PRELIMINARY
PAGE 8 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
4
1
5
3
7 6
2
Figure 3. Single Site Programmer board. The software will produce undesirable results if any of the hardware setup is missing or not installed properly.
1 PRELIMINARY
PAGE 9 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
4 Hardware Setup and Installation Each Single Site Programmer board consists of single pogo pin fixture. A sample board is shown in Figure 2. The programmer HW site has its own DB9 connector through which the program can access the module and program it.
To PC DB9 connector
To 3.3V Power supply
Figure 4. Hardware setup
1 PRELIMINARY
PAGE 10 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
The board requires a 3.3V supply to power HW. The RUN/PROGRAM switch should be set to PROGRAM when programming and in RUN mode when performing QA. The hardware setup is shown in Figure 4.
4.1 Populating the site Before populating the site the operator must power off the board; every time. The GS1011/GS1500 modules need to be mounted with the logo/product label facing up and the module pins aligned with the pogo pins. Press down gently to ensure the module lays flat on the pogo pin fixture. Once the module is loaded, close the cover gently and engage the toggle clamp all the way to ensure there is even pressure on the site to make good pin contact (Figure 5 & 6)
Figure 5. Populating the site.
1 PRELIMINARY
PAGE 11 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
Figure 6. With cover closed and toggle clamp engaged.
1 PRELIMINARY
PAGE 12 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
5 Software Test Setup and Requirements The list of compatible software required to run the test includes: 1.) Windows XP SP2/SP3 or Windows 7 2.) LabVIEW runtime engine 2009 or later (provided with installation package) 3.) Single Site Programmer application 4.) Prolific USB-Serial Drivers 5.) Bar code Scanner drivers (if required)
5.1 Installing the Single Site Programmer software From the Single Site Programmer\Volume folder, run setup.exe. Follow the prompts to install the software. Restart the PC, if required. Upon successful installation, you should discover the Single Site Programmer 1p0 under Start>Single Site Programmer. User may launch the application from here or from \ Single Site Programmer folder.
5.2 The GUI Launch the Single Site Programmer 1p0.exe GUI. If the installation was successful, the user should see the GUI in Figure 7.
Figure 7. The GUI
1 PRELIMINARY
PAGE 13 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
9 1 8
6 2 7
3
4
5
Figure 8. GUI Segments The various segments of the GUI are listed below. Table 2. SW segments Item
Segment
Description/Use
1
COM Port
COM port to which the Single Site Programmer is hooked up to.
2
Status
Shows the current status of the program and intimates user.
3
WLAN
The WLAN firmware currently being loaded.
4
APP0
The APP0 firmware currently being loaded.
5
APP1
The APP1 firmware currently being loaded.
6
MAC ID
MAC ID of the module
7
Progress
Displays each step of the programming/QA process
8
MAC ID OK?
Green if MAC ID is valid, red otherwise.
9
Code Loaded? Green if WLAN, APP0 and APP1 are loaded successfully.
1 PRELIMINARY
PAGE 14 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
5.3 Using the configuration file A configuration file is provided with the SW to control the program flow. Open the Single Site Programmer.ini file using Notepad(Figure 9). Listed below are the fields and options.
Figure 9. Single Site Programmer configuration file Table 3. Configuration file settings Item
Name
Description/Options
1
COM Port
COM port to which the Single Site Programmer is hooked up to.
2
WLAN FW File name of WLAN Firmware
3
APP0
The APP0 firmware currently being loaded.
4
APP1
The APP1 firmware currently being loaded.
1 PRELIMINARY
PAGE 15 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
6 Running the GUI In order to run the SW in PROGRAM MODE, follow these steps. 1) Open the Single Site Programmer.ini file. Provide the correct WLAN, APP0 and APP1 file names and place all the three files in the same folder as the program. Enter the COM Port to which the HW is connected to. 2) Save and close the Single Site Programmer.ini file. 3)
Open the Single Site Programmer.exe (Figure 10).
Figure 10. SW in Programming Mode 4)
The Status box should display “PROGRAMMING MODE. Check if board is in PROGRAM MODE. HIT SPACE TO BEGIN”. If not, close the program and re-edit the configuration file(step 1).
5)
Ensure the Power Switch is OFF. Load the module, toggle the RUN/PROGRAM switch to PROGRAM.
6)
Switch the power to ON position and hit space.
7)
The program will begin loading the firmwares (Figure 11).
1 PRELIMINARY
PAGE 16 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
Figure 11. Loading firmwares 8)
If the loading was successful the MAC ID OK? and Code Loaded? indicators will turn bright green (Figure 12). If the loading was unsuccessful toggle power and repeat from Step 5.
Figure 12. Firmware loading Successful 9)
Load another module and repeat from Step 6.
6.1 Notes 1.
2.
If the progress dialog does not update or if the program stops responding for any reason, please close the Single Site Programmer 1p0.exe and re-launch. Ensure correct settings in Single Site Programmer.ini file. Incorrect settings will result in program to hang or crash.
1 PRELIMINARY
PAGE 17 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
6.2 Caution: Care has to be taken while closing the cover of the hardware. Excessive force will result in modules getting damaged and reduced lifetime of the hardware.
1 PRELIMINARY
PAGE 18 OF 19
SINGLE SITE PROGRAMMER QUICK START GUIDE
7 Appendix A List of items and description Item
Description
Picture
Test fixture
To load and program modules
Null modem cable
Connect between USB-Hub and DB9 connector on fixture.
Handy Vac
To lift and place modules.
3.3V Power Supply
To power up the test fixture and modules.
Power plug adapters
To use in different countries
1 PRELIMINARY
PAGE 19 OF 19
