View source

__TOC__
This is the wiki page for [http://asynclabs.com/ www.asynclabs.com]
Visit the [http://asynclabs.com/forums AsyncLabs forums] if you have any questions.
If you are looking for documentation help getting your new widget off the ground, then you've hit the right place!  
The documentation is split up based on project, so feel free to browse around and read as necessary.
'''''Note that you do NOT have to register for the wiki in order to read the documentation!'''''  You only need to register if you want to contribute your findings to the documentation.
----
== Hardware ==
Feature descriptions, pin usage, schematics and gerber files.
The design files for the following boards are distributed under a Creative Commons license [http://creativecommons.org/licenses/by-sa/2.5/ Attribution-ShareAlike 2.5].
===WiFi enabled I/O boards===
[[BlackWidow 1.0]]
[[YellowJacket 1.0]]
===WiFi and other shields===
[[WiShield 1.0]]
[[WiShield 2.0]]
[[FlashShield 1.0]]
----
== Software ==
The latest WiShield software release version : '''v1.3.0'''
For information regarding changes, feature additions, please see [[Release notes]]
The latest dataflash software release version : '''v1.0.0'''
=== Installation instructions for WiShield/BlackWidow/YellowJacket===
To use the software, please do the following:
#Download the WiShield library below.
#Put all the files/directories under <arduino sketch dir>/libraries/WiShield/ directory.
#Restart the Arduino environment, so that the library files get built and the sketches become available.
=== Installation instructions for WiShield '''2.0'''/FlashShield ===
The FlashShield requires the dataflash library, which is hosted on github.  The WiShield 2.0 will require both the WiShield library and dataflash library.
#Download the dataflash library below.
#Put all the fiels/directories under <arduino sketch dir>/libraries/dataflash/ directory.
#Restart the Arduino enviornment, so that the library files get built and the sketches become available.
=== Download ===
Link to the WiShield library files. Please download files from the link mentioned below and place them in the WiShield library folder
[[WiShield library]]
*Includes the driver files for the ZeroG Wireless G2100 WiFi device and the TCP/IP stack files
[[dataflash library]]
=== Documentation ===
[[WiServer]]
Note that WiServer is an add-on to the WiShield TCP/IP stack and ZeroG driver that allows for a more robust and user-friendly interface for webpage creation.  WiServer will '''require''' an ATMEGA328.  Should you choose not to use WiServer, a standard ATMEGA168 will suffice.  Follow the instructions in the links below to enable the sketches.
==== How to use the sample sketches ====
Instructions for configuring and using the sample sketches included in the library:
[[WiServer sketches]]
[[WebServer sketch]]
[[WebClient sketch]]
[[SocketApp sketch]]
[[UDPApp sketch]]
----
== Out of box Setup ==
#Download the software and put it into the right directory as described in the Software section above.
#Plug the WiShield into the Arduino board. Leave jumpers in default positions. The LED jumper (JP3) connected and the interrupt jumper (JP2) configured to use the INT0 pin.
#Restart the Arduino IDE to build the library and open the WebServer sketch from File->Sketchbook->Examples->Library->WiShield.
#The next step involves setting up the wireless configuration parameters like SSID and security for your wireless network. These parameters are defined at the top of the WebServer sketch.
#Find out the SSID of your wireless AP/router. You can get it by looking at the configuration setting of the wireless connection on laptop or by logging into you AP/router's config page.
#You need to figure out a good IP address to use for your WiShield. For this, you will have to find out the subnet mask and IP address range that your network uses. This can be found on a PC by right-clicking on the network connection icon at the bottom right corner of the taskbar and selecting 'Status'. Click on the Support tab. It might look something like,
#*IP address : 192.168.1.100
#*Subnet mask : 255.255.255.0
#*Default Gateway: 192.168.1.1
#We are only interested in getting a good IP address. What the subnet mask specifies is the network address. In the above case, the network address is 192.168.1.xxx and therefore all devices on this network will have IP addresses starting with '192.168.1'. This might be different for your AP. Since the current WiShield does not have support for DHCP you will have to select an IP address starting with this subnet mask. Just make sure you select something that is not used by any other device on your network.
#Change the local_ip variable in the sketch to your selected IP address. Change the ssid variable to your network SSID.
#The next step is to setup the right security options. The WiShield supports open (no security), WEP, WPA/TKIP-PSK, WPA2/AES-PSK. You might have to look at you AP/router configuration page to get this information unless you already know it. Change the security_type variable to select the appropriate security type. Depending on your security_type selection, you will now have to modify the security_passphrase/wep_keys variable to match you network settings.
#The sketch configures WiShield to connect to the AP (infrastructure mode) by default.
#The webpage[] array holds the webpage that this WebServer will serve up when requested.
#You are now all set to power up the WiShield. Compile the sketch and load it into the Arduino board.
#The red LED indicates connection status. Wait for the LED to turn on. The amount of time required to connect to the network varies depending on the security_type setting. If you selected open/WEP it should take 3/4 seconds to connect. If you selected WPA/WPA2, it takes slightly more than 30 seconds as the WiFi device needs to calculate the PSK from the passphrase for use in the security handshake.
#Once the red LED turns on, you are ready to talk to the device.
#You can try pinging the device by starting a terminal and typing,
#*$ ping <IP address of WiShield>
#*For example, $ ping 192.168.1.2 and you should see the WiShield respond to these ping requests
#If successful, fire up a browser and enter for example, <nowiki>http://192.168.1.2</nowiki> and you should see the webpage displayed in your browser window.
#Now you are all set to be creative and come up with some interesting applications with the WiShield.
If you run into any issues please post your questions on the [http://asynclabs.com/forums AsyncLabs forums].
----
== Troubleshooting ==
A community maintained list of APs that are know to work with the WiShield:
[[AP compatibility list]]