Changes between Version 2 and Version 3 of gettingstarted


Ignore:
Timestamp:
05/02/2018 10:34:37 PM (15 months ago)
Author:
Cale Collins
Comment:

Major restructuring of getting started began!!

Legend:

Unmodified
Added
Removed
Modified
  • gettingstarted

    v2 v3  
    66Welcome!  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.
    77
    8 Gateworks single board computers (SBC) are powerful, low power network processor boards that are unlimited in their capabilities.  Typically, 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 & Newport family also supports other BSPs that can be found on the [wiki:ventana Ventana Product Wiki Page] & [wiki:newport Newport Product Wiki Page].
     8Gateworks single board computers (SBC) are powerful, low power network processor boards that are unlimited in their capabilities.  Typically, you will find OpenWrt (Linux) pre-installed 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 & Newport family also supports other BSPs that can be found on the [wiki:ventana Ventana Product Wiki Page] & [wiki:newport Newport Product Wiki Page].
    99
    1010We 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
     13= Required items =
     14To get started and get connected to your board '''you will need''':
     15 1. Gateworks Single Board Computer
     16 2. Power supply (there are many options here, please use the supply sent with the development kit to get started)
     17 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]
     18 4. A computer, preferably a Linux machine such as Ubuntu.  Windows will also work. 
     19 1. Operating Manuals are also available online at [http://www.gateworks.com/usermanuals] which contain very helpful information.
     20 
     21= Physical Connections =
     22There are two main connections to the single board computer ( SBC ). 
     23 1. Power
     24 2. Communication
     25
     26
     27== Power ==
     28 * Most Gateworks' boards support voltages between 10VDC - 48VDC. Please consult the operating manual.
     29 * 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.
     30 * Some boards require a 2 pin specialty connector. Silkscreen labels are often labeled VIN for voltage input.
     31 * 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]
     32
     33== Communication ==
     34USB JTAG Dongle (included with development kits, or sold separately  [https://shop.gateworks.com/index.php?route=product/category&path=70_80 Buy a Jtag] - This device is necessary for serial console access.
     35
     36Example Configuration:
     37 [[Image(VentanaJTAG.jpg,600px)]]
     38
     39
     40= First Steps =
     41Steps to get to a '''command prompt''' on the board:
     42
     43 1. Serial Console.
     44  * Please go through the setup instructions for connecting the USB JTAG Programmer to a Host PC. 
     45   * [wiki:jtag_instructions#SerialConsoleAccessonLinux Linux Serial Console instructions]
     46   * [wiki:jtag_instructions#Windows Windows Serial Console instructions]
     47 1. '''Connect:''' the communication cables, such as the JTAG cable or an ethernet cable or serial cable.
     48 1. '''Start console program''' (configured in step 1.)
     49 1. '''Connect power.'''
     50 1. The board will start '''outputting text out of the serial console'''.
     51  * Yocto OS Login: root
     52  * See example picture below:
     53
     54  [[Image(prompt.png,500px)]]
     55
     56
     57
     58= Next Steps =
     59Now that you can login to the board, the options are unlimited! Start using the Gateworks board for your intended use!
     60
     61'''There is lots of great information on the [wiki: Gateworks Software Wiki] homepage pointing to many examples, hints, tips, and tricks! '''
     62
     63Please 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.
     64
     65Recommended reading:
     66 * [wiki:jtag_instructions#PhysicalConnections JTAG page]
     67
     68Feel free to contact us for any support at support@gateworks.com
    1169
    1270= Software Update =
     
    1775  * [wiki:newport Newport]
    1876
    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. 
     77== Installing Firmware ==
     78Gateworks 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:
     79 * 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]
     80 * TFTP Ethernet: as detailed here (bootloader specific):
     81  * [wiki:newport Newport Family]
     82  * [wiki:ventana/openwrt Ventana OpenWrt Specific]
     83  * [wiki:laguna/openwrt Laguna OpenWrt Specific]
     84  * [wiki:rincon/openwrt Rincon OpenWrt Specific]
     85  * [wiki:avila/openwrt Avila OpenWrt Specific]
     86  * [wiki:cambria/openwrt Cambria OpenWrt Specific]
    2587
    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).
     882. 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).
    3089  1. Pre-built binaries can be found on each family's respective page: [http://trac.gateworks.com/#QuickLinksforBoardSpecificInfoandPre-BuiltBinaryImagesSoftware See here]
    3190  2. Building / Compiling firmware:
     
    41100
    42101
    43 = Physical Connections =
    44 There are two main connections to the single board computer ( SBC ). 
    45  1. Power
    46  2. Communication
    47 
    48 
    49 == Power ==
    50  * Most Gateworks' boards support voltages between 10VDC - 48VDC. Please consult the operating manual.
    51  * 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.
    52  * Some boards require a 2 pin specialty connector. Silkscreen labels are often labeled VIN for voltage input.
    53  * 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]
    54 
    55 == Communication ==
    56  * '''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.
    57  * Most boards typically have one ethernet port.  Boards with two ethernet ports, the left port is typically the main use port.
    58  * Serial Cable - Certain boards have a serial DB9 connector that will allow access to a console.
    59 
    60 Example Configuration:
    61  [[Image(VentanaJTAG.jpg,200px)]]
    62 
    63 See also:
    64  * [wiki:jtag_instructions#PhysicalConnections JTAG page]
    65 
    66 
    67 = First Steps =
    68 Steps to get to a '''command prompt''' on the board:
    69 
    70  1. '''CHOOSE one communication option below and install:'''
    71   1. Serial Console / JTAG - Often '''preferred''' because '''network configuration is not required'''.
    72    * Please go through the setup instructions for connecting the USB JTAG Programmer to a Host PC.  [wiki:jtag_instructions Serial / Jtag Page Here]
    73    * ''' Serial console is achieved through JTAG Programmer''' (Or DB9 connector if available)
    74   2. [wiki:OpenWrt/webadmin GUI Login] in any web browser  (by default ip is 192.168.1.1)
    75   3. Telnet (use command line, ex: putty for windows, shell for linux ie: telnet 192.168.1.1)
    76   4. SSH (example: ssh root@192.168.1.1)
    77  2. Be sure all software is configured, setup, installed, and open on the host PC (for example, drivers installed, com port identified, etc).
    78  3. '''Connect:''' the communication cables, such as the JTAG cable or an ethernet cable or serial cable.
    79  4. '''Connect power.'''
    80  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. 
    81   * Yocto OS Login: root
    82   * See example picture below:
    83 
    84   [[Image(prompt.png,500px)]]
    85 
    86 == Installing Firmware ==
    87 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:
    88  * 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]
    89  * TFTP Ethernet: as detailed here (bootloader specific):
    90   * [wiki:newport Newport Family]
    91   * [wiki:ventana/openwrt Ventana OpenWrt Specific]
    92   * [wiki:laguna/openwrt Laguna OpenWrt Specific]
    93   * [wiki:rincon/openwrt Rincon OpenWrt Specific]
    94   * [wiki:avila/openwrt Avila OpenWrt Specific]
    95   * [wiki:cambria/openwrt Cambria OpenWrt Specific]
    96 
    97 
    98 = Next Steps =
    99 Now that you can login to the board, the options are unlimited! Start using the Gateworks board for your intended use!
    100 
    101 '''There is lots of great information on the [wiki: Gateworks Software Wiki] homepage pointing to many examples, hints, tips, and tricks! '''
    102 
    103 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.
    104 
    105 Feel free to contact us for any support at support@gateworks.com