| | 1 | [[PageOutline]] |
| | 2 | |
| | 3 | [[Image(gw5100actual.png,200px)]] |
| | 4 | |
| | 5 | = Getting Started with a Gateworks SBC = |
| | 6 | Welcome! Thank you for purchasing a Gateworks single board computer (SBC). We hope to get you started with a little bit of info from our Gateworks wiki site. |
| | 7 | |
| | 8 | Gateworks single board computers (SBC) are powerful, low power network processor boards that are unlimited in their capabilities. They run a version of Linux called OpenWrt by default, and thus a lot of information is devoted towards configuring and using the OpenWRT software. Because OpenWrt is open source, Gateworks encourages customers to also leverage the open source community of [http://www.openwrt.org OpenWrt] on the web! The Ventana family also supports other BSPs that can be found on the [wiki:ventana Ventana Product Wiki Page]. |
| | 9 | |
| | 10 | We highly encourage you to utilize this wiki ([wiki:WikiStart#HowtoUsethisWiki How to Use Gateworks Wiki]) after getting your single board computer turned on with the step by step instructions below. |
| | 11 | |
| | 12 | = Software Update = |
| | 13 | |
| | 14 | The Gateworks SBC is shipped with software pre-installed. However, software is continually being enhanced and improved. Gateworks recommends reviewing the latest versions compared to what is already installed and updating accordingly. |
| | 15 | * Bootloader Updates |
| | 16 | * [wiki:ventana/bootloader Ventana Bootloader] |
| | 17 | * OS Updates |
| | 18 | * [wiki:ventana Ventana Software] |
| | 19 | = Required items = |
| | 20 | To get started and get connected to your board '''you will need''': |
| | 21 | 1. Gateworks Single Board Computer |
| | 22 | 2. Power supply (there are many options here, please use the supply sent with the development kit to get started) |
| | 23 | 3. JTAG USB Programmer - not required but '''VERY''' helpful. Used for programming board and serial console access. (Included in development kit) More info on JTAG [wiki:jtag_instructions here] |
| | 24 | 4. A computer, preferably a Linux machine such as Ubuntu. Windows will also work. |
| | 25 | |
| | 26 | |
| | 27 | Optional: |
| | 28 | 1. Operating Manuals are also available online at [http://www.gateworks.com/usermanuals] which contain very helpful information. |
| | 29 | 2. Software - Firmware image - (Note: Your board comes with the firmware pre-installed, so you may be able to skip this step. ), typically OpenWRT, the Linux distribution that Gateworks runs on the SBC (single board computers) [wiki:OpenWrt]- either download a pre-built binary from our website, or compile your own (Linux only). |
| | 30 | 1. Pre-built binaries can be found on each family's respective page: [http://trac.gateworks.com/#QuickLinksforBoardSpecificInfoandPre-BuiltBinaryImagesSoftware See here] |
| | 31 | 2. Building / Compiling firmware: |
| | 32 | * [wiki:ventana/openwrt OpenWrt for Ventana Family] |
| | 33 | * [wiki:Android Android for Ventana Family] |
| | 34 | * [wiki:ventana/ubuntu Ubuntu for Ventana Family] |
| | 35 | * [wiki:Yocto Yocto for Ventana Family] |
| | 36 | * [wiki:laguna/openwrt OpenWrt Laguna Family] |
| | 37 | * [wiki:rincon/openwrt OpenWrt for Rincon Family] |
| | 38 | * [wiki:avila/openwrt OpenWrt for Avila Family] |
| | 39 | * [wiki:cambria/openwrt OpenWrt for Cambria Family] |
| | 40 | |
| | 41 | |
| | 42 | = Physical Connections = |
| | 43 | There are two main connections to the single board computer ( SBC ). |
| | 44 | 1. Power |
| | 45 | 2. Communication |
| | 46 | |
| | 47 | |
| | 48 | == Power == |
| | 49 | * Most Gateworks' boards support voltages between 10VDC - 48VDC. Please consult the operating manual. |
| | 50 | * If a development kit was purchased, a 12V or 24V DC Wall supply is included that will connect to the power connector barrel jack on the GateworksSBC. |
| | 51 | * Some boards require a 2 pin specialty connector. Silkscreen labels are often labeled VIN for voltage input. |
| | 52 | * POE is possible on certain models. 802.3af is available on certain models. Passive POE between 10-48VDC is often supported. Please consult the user manual. [wiki:poe POE Information] |
| | 53 | |
| | 54 | == Communication == |
| | 55 | * '''USB JTAG Programmer - This is the method most preferred and used most often at Gateworks Headquarters.''' - Serial console access can be achieved through this programmer. |
| | 56 | * Most boards typically have one ethernet port. Boards with two ethernet ports, the left port is typically the main use port. |
| | 57 | * Serial Cable - Certain boards have a serial DB9 connector that will allow access to a console. |
| | 58 | |
| | 59 | Example Configuration: |
| | 60 | [[Image(VentanaJTAG.jpg,200px)]] |
| | 61 | |
| | 62 | See also: |
| | 63 | * [wiki:jtag_instructions#PhysicalConnections JTAG page] |
| | 64 | |
| | 65 | |
| | 66 | = First Steps = |
| | 67 | Steps to get to a '''command prompt''' on the board: |
| | 68 | |
| | 69 | 1. '''CHOOSE one communication option below and install:''' |
| | 70 | 1. Serial Console / JTAG - Often '''preferred''' because '''network configuration is not required'''. |
| | 71 | * Please go through the setup instructions for connecting the USB JTAG Programmer to a Host PC. [wiki:jtag_instructions Serial / Jtag Page Here] |
| | 72 | * ''' Serial console is achieved through JTAG Programmer''' (Or DB9 connector if available) |
| | 73 | 2. [wiki:OpenWrt/webadmin GUI Login] in any web browser (by default ip is 192.168.1.1) |
| | 74 | 3. Telnet (use command line, ex: putty for windows, shell for linux ie: telnet 192.168.1.1) |
| | 75 | 4. SSH (example: ssh root@192.168.1.1) |
| | 76 | 2. Be sure all software is configured, setup, installed, and open on the host PC (for example, drivers installed, com port identified, etc). |
| | 77 | 3. '''Connect:''' the communication cables, such as the JTAG cable or an ethernet cable or serial cable. |
| | 78 | 4. '''Connect power.''' |
| | 79 | 5. The board will start '''outputting text out of the serial console'''. If a network connection method is being used, please wait a few seconds until a network connection is attempted. |
| | 80 | * Yocto OS Login: root |
| | 81 | * See example picture below: |
| | 82 | |
| | 83 | [[Image(prompt.png,500px)]] |
| | 84 | |
| | 85 | == Installing Firmware == |
| | 86 | Gateworks Boards are shipped with a default firmware pre-installed, but if you want a specific BSP or version, or want to ensure you have the latest firmware you can update it in a couple different ways: |
| | 87 | * JTAG: Flash your board with binary image from a binary listed in step [wiki:#Requireditems above] or the one you compiled using a USB JTAG Programmer and these [wiki:jtag_instructions JTAG Instructions] |
| | 88 | * TFTP Ethernet: as detailed here (bootloader specific): |
| | 89 | * [wiki:ventana/openwrt Ventana OpenWrt Specific] |
| | 90 | * [wiki:laguna/openwrt Laguna OpenWrt Specific] |
| | 91 | * [wiki:rincon/openwrt Rincon OpenWrt Specific] |
| | 92 | * [wiki:avila/openwrt Avila OpenWrt Specific] |
| | 93 | * [wiki:cambria/openwrt Cambria OpenWrt Specific] |
| | 94 | |
| | 95 | |
| | 96 | = Next Steps = |
| | 97 | Now that you can login to the board, the options are unlimited! Start using the Gateworks board for your intended use! |
| | 98 | |
| | 99 | '''There is lots of great information on the [wiki: Gateworks Software Wiki] homepage pointing to many examples, hints, tips, and tricks! ''' |
| | 100 | |
| | 101 | Please use the '''search box''' in the top right hand corner as well! '''Product Manuals''' are also available online at [http://www.gateworks.com/usermanuals] which contain very helpful information. |
| | 102 | |
| | 103 | Feel free to contact us for any support at support@gateworks.com |
