User Tools

Site Tools


meta:template_device

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Previous revision
meta:template_device [2013/03/22 08:55]
meta:template_device [2016/02/09 13:19] (current)
tmomas Style definitions for datatables removed (included in css now)
Line 1: Line 1:
 +====== @@Brand@@ @@Model@@ @@Version|@@======
  
 +/* This template is intended to be used via https://​wiki.openwrt.org/​meta/​create_new_device_page ONLY.  */
 +/* DO NOT CREATE NEW DEVICEPAGES VIA COPY & PASTE! */
 +/* USE https://​wiki.openwrt.org/​meta/​create_new_device_page */
 +
 +| {{page>​meta:​infobox:​construction&​noheader&​nofooter&​noeditbtn}} |
 +
 +//Write a short, relevant description of the device. Include a technical overview, but avoid marketing buzzwords/​useless stuff. Two to four sentences is about right. A picture is good, too. Edit the page to see how to add pictures.//
 +
 +<WRAP BOX>
 +FIXME Any text with a light background (like this one) provides instructions for creating the Details Page. When you have filled in correct/​useful information (instead of any template that's there) **remove the instructions,​ as well as the ''<​nowiki><​WRAP></​nowiki>''​ that encloses it.**
 +</​WRAP>​
 +
 +/*****/
 +/* How to add images ========>​ http://​wiki.openwrt.org/​meta/​adding_images_to_openwrt_wiki */
 +/*****/
 +
 +{{media:​example:​genericrouter1.png?​200|Generic Router}}
 +
 +<WRAP BOX>
 +FIXME
 +===== Getting started with a new Device Page =====
 +  - This is an empty template that suggests the information that should be present on a well-constructed Device Page. This means, that **you have to fill it with life and information.**
 +  - There are several "​fixme"​ tags with text on a light background (like this text) throughout this template. As you fill in the page, remove those tags so that people can judge its completeness.
 +  - When there are no more "​fixme"​ tags left, delete this one too, along with the ''<​nowiki><​WRAP></​nowiki>''​ that encloses it.
 +
 +===== Keep the articles modular =====
 +  * Please include only model specific information,​ omit bla,bla and put everything generic into separate articles
 +  * If you have no time to write certain stuff, link to [[doc/​howto/​generic.overview]]
 +  * [[doc/​howto/​basic.config]] should lead the way, do not explain this again
 +  * DO NOT provide a complete howto here! Instead //groom// the general [[doc:​howto:​start|HowTos]].
 +</​WRAP>​
 +
 +===== Supported Versions =====
 +
 +<WRAP BOX>
 +FIXME
 +  - The tables below are automatically generated, **once the correct filters for Brand and Model are set.**
 +  - If the tables below show information for ''<​nowiki>​@@Brand@@ @@Model@@ @@Version|@@</​nowiki>'',​ everything is OK and you can delete this text and the ''<​nowiki><​WRAP></​nowiki>''​ that encloses it.
 +  - If the tables below contain "​Nothing found",​ it means that either
 +    - the dataentry page for @@Brand@@ @@Model@@ @@Version|@@ is missing. Please [[meta:​create_new_dataentry_page|create a new dataentry page]] first, then reload this page. The tables should then contain $something. If they do, delete this text and the ''<​nowiki><​WRAP></​nowiki>''​ that encloses it.
 +    - filters are not set correctly -> Please **edit this section and adjust the filters with the proper Brand and Model.** Just try, it's easy. The tables should then contain $something. If they do, delete this text and the ''<​nowiki><​WRAP></​nowiki>''​ that encloses it.
 +  - If the tables still contain "​Nothing found":​ Don't panic, calm down, take a deep breath and [[about:​contact|contact a wiki admin]] (tmomas) for help.
 +</​WRAP>​
 +
 +---- datatable ----
 +cols    : Brand, Model, Versions, Supported Current Rel, OEM device homepage URL_url, Forum Topic URL_url, Device Techdata_pageid
 +headers : Brand, Model, Version, Current Release, OEM Info, Forum Topic, Technical Data
 +align   : c,​c,​c,​c,​c,​c,​c,​c
 +filter ​ : Brand=@@Brand@@
 +filter ​ : Model=@@Model@@
 +filter ​ : Versions~@@Version|@@
 +----
 +
 +===== Experimental Versions =====
 +
 +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 
 + ​* ​  The official Table of Hardware only lists current, stable versions of OpenWrt. ​ *
 + ​* ​  Use this space to describe any on-going efforts to create a newer version ​      *
 + ​* ​  of the firmware for this device. Provide links to firmware images, ​             *
 + ​* ​  ​active threads on the forum, or other sources of information. ​                  *
 + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 +
 +//None at this time.//
 +
 +===== Hardware Highlights =====
 +---- datatable ----
 +cols    : Model, Versions, Platform, CPU MHz, Flash MB_mbflashs,​ RAM MB_mbram, WLAN Hardware, WLAN 2.4Ghz, WLAN 5.0Ghz, Ethernet 100M ports_, Ethernet Gbit ports_, Modem, USB ports_
 +header ​ : Model, Version,​SoC,​CPU MHz,Flash MB,RAM MB,WLAN Hardware,​WLAN2.4,​WLAN5.0,​100M ports,Gbit ports,​Modem,​USB
 +align   : c,​c,​c,​c,​c,​c,​c,​c,​c,​c,​c,​c
 +filter ​ : Brand=@@Brand@@
 +filter ​ : Model=@@Model@@
 +filter ​ : Versions~@@Version|@@
 +----
 +
 +===== Installation =====
 +  - → [[doc:​howto:​obtain.firmware|Obtain firmware]]
 +  - → [[doc:​howto:​generic.flashing|Install OpenWrt]]
 +  - → [[about:​latest|Latest OpenWrt release]]
 +
 +---- datatable ----
 +cols    : Model, Versions, Supported Current Rel, Firmware OpenWrt Install URL_url, Firmware OpenWrt Upgrade URL_url, Firmware OEM Stock URL_url
 +align   : l,c
 +filter ​ : Brand=@@Brand@@
 +filter ​ : Model=@@Model@@
 +filter ​ : Versions~@@Version|@@
 +----
 +
 +==== Flash Layout ====
 +<WRAP BOX>
 +FIXME //​[[:​doc:​techref:​flash.layout#​discovery_how_to_find_out|Find out flash layout]], then add the flash layout table here (copy, paste, modify the [[doc:​techref:​flash.layout#​partitioning_of_squashfs-images|example]]).//​
 +
 +Please check out the article [[doc:​techref:​Flash.Layout|Flash layout]]. It contains examples and explanations that describe how to document the flash layout.
 +</​WRAP>​
 +
 +==== OEM easy installation ====
 +
 +<WRAP BOX>
 +FIXME The instructions below are for Broadcom devices and only serve as an example. Remove / modify them if they do not apply to this particular device!
 +
 +This section deals with
 +  * How you install OpenWrt from a device freshly opened
 +  * The steps required such as reset to factory defaults if the device has already been configured
 +
 +**Note:** Reset router to factory defaults if it has been previously configured.
 +  *Browse to http://​192.168.1.1/​Upgrade.asp
 +  *Upload .bin file to router
 +  *Wait for it to reboot
 +  *Telnet to 192.168.1.1 and set a root password, or browse to http://​192.168.1.1 if LuCI is installed.
 +</​WRAP>​
 +
 +==== OEM installation using the TFTP method ====
 +
 +->  [[doc:​howto:​generic.flashing.tftp]]
 +
 +=== Specific values needed for tftp ===
 +
 +<WRAP BOX>
 +
 +FIXME Enter values for "​FILL-IN"​ below
 +
 +^ Bootloader tftp server IPv4 address ​ | FILL-IN ​  |
 +^ Bootloader MAC address (special) ​    | FILL-IN ​  |
 +^ Firmware tftp image                  | [[about:​latest|Latest OpenWrt release]] (**''​NOTE:''​** Name must contain //"​tftp"//​) |
 +^ TFTP transfer window ​                | FILL-IN seconds ​                               |
 +^ TFTP window start                    | approximately FILL-IN seconds after power on   |
 +^ TFTP client required IP address ​     | FILL-IN ​                                       |
 +
 +</​WRAP>​
 +
 +===== Upgrading OpenWrt =====
 +->  [[doc:​howto:​generic.sysupgrade]]
 +
 +<WRAP BOX>
 +
 +FIXME These are generic instructions. Update with your router'​s specifics.
 +
 +==== LuCI Web Upgrade Process ====
 +
 +  * Browse to http://​192.168.1.1/​cgi-bin/​luci/​mini/​system/​upgrade/​ LuCI Upgrade URL
 +  * Upload image file for sysupgrade to LuCI
 +  * Wait for reboot
 +
 +==== Terminal Upgrade Process ====
 +
 +If you don't have a GUI (LuCI) available, you can alternatively upgrade via the command line.
 +There are two command line methods for upgrading:
 +
 +  * ''​sysupgrade''​
 +  * ''​mtd''​
 +
 +Note: It is important that you put the firmware image into the ramdisk (/tmp) before you start flashing.
 +
 +=== sysupgrade ===
 +
 +  * Login as root via SSH on 192.168.1.1,​ then enter the following commands:
 +
 +<​code>​
 +cd /tmp
 +wget http://​downloads.openwrt.org/​snapshots/​trunk/​XXX/​xxx.abc
 +sysupgrade /​tmp/​xxx.abc
 +</​code>​
 +
 +=== mtd ===
 +
 +If ''​sysupgrade''​ does not support this router, use ''​mtd''​.
 +
 +  * Login as root via SSH on 192.168.1.1,​ then enter the following commands:
 +
 +<​code>​
 +cd /tmp
 +wget http://​downloads.openwrt.org/​snapshots/​trunk/​XXX/​xxx.abc
 +mtd write /​tmp/​xxx.abc linux && reboot
 +</​code>​
 +
 +</​WRAP>​
 +
 +===== Debricking =====
 +-> [[doc:​howto:​generic.debrick]]
 +
 +===== Failsafe mode =====
 +-> [[doc:​howto:​generic.failsafe]]
 +
 +===== Basic configuration =====
 +-> [[doc:​howto:​basic.config|Basic configuration]] After flashing, proceed with this.\\
 +Set up your Internet connection, configure wireless, configure USB port, etc.
 +
 +===== Specific Configuration =====
 +
 +<WRAP BOX>
 +FIXME Please fill in real values for this device, then remove the EXAMPLEs
 +
 +==== Network interfaces ====
 +The default network configuration is:
 +^ Interface Name   ^ Description ​                 ^ Default configuration ​   ^
 +| br-lan ​          | EXAMPLE LAN & WiFi           | EXAMPLE 192.168.1.1/​24 ​  |
 +| vlan0 (eth0.0) ​  | EXAMPLE LAN ports (1 to 4)   | EXAMPLE None             |
 +| vlan1 (eth0.1) ​  | EXAMPLE WAN port             | EXAMPLE DHCP             |
 +| wl0              | EXAMPLE WiFi                 | EXAMPLE Disabled ​        |
 +
 +</​WRAP>​
 +
 +==== Switch Ports (for VLANs) ====
 +<WRAP BOX>
 +FIXME Please fill in real values for this device, then remove the EXAMPLEs
 +
 +Numbers 0-3 are Ports 1-4 as labeled on the unit, number 4 is the Internet (WAN) on the unit, 5 is the internal connection to the router itself. Don't be fooled: Port 1 on the unit is number 3 when configuring VLANs. vlan0 = eth0.0, vlan1 = eth0.1 and so on.
 +^ Port             ^ Switch port   ^
 +| Internet (WAN)   | EXAMPLE 4     |
 +| LAN 1            | EXAMPLE 3     |
 +| LAN 2            | EXAMPLE 2     |
 +| LAN 3            | EXAMPLE 1     |
 +| LAN 4            | EXAMPLE 0     |
 +
 +</​WRAP>​
 +
 +==== Buttons ====
 +-> [[doc:​howto:​hardware.button]] on howto use and configure the hardware button(s).
 +Here, we merely name the buttons, so we can use them in the above Howto.
 +
 +<WRAP BOX>
 +FIXME Please fill in real values for this device, then remove the EXAMPLEs
 +
 +The @@Brand@@ @@Model@@ has the following buttons:
 +
 +^ BUTTON ​                      ^ Event   ^
 +| EXAMPLE Reset                |  reset  |
 +| EXAMPLE Secure Easy Setup    |   ​ses ​  |
 +| EXAMPLE No buttons at all.   ​| ​   -    |
 +
 +</​WRAP>​
 +
 +===== Hardware =====
 +==== Info ====
 +<WRAP BOX>
 +FIXME
 +  - This table is automatically generated, **once the correct filters for Brand and Model are set.**
 +  - If you see "​Nothing."​ instead of a table, please **edit this section and adjust the filters with the proper Brand and Model.** Just try, it's easy.
 +  - If you still don't see a table here, or a table filled with '​¿':​ [[toh:​start|Is there already a Techdata page available]] for @@Brand@@ @@Model@@ @@Version|@@?​ If not: [[meta:​create_new_dataentry_page|Create one]].
 +  - If you see a table with the desired device data, everything is OK and you can delete this text and the ''<​nowiki><​WRAP></​nowiki>''​ that encloses it.
 +  - If it still doesn'​t work: Don't panic, calm down, take a deep breath and [[about:​contact|contact a wiki admin]] (tmomas) for help.
 +</​WRAP>​
 +
 +---- datatemplatelist dttpllist ----
 +template: meta:​template_datatemplatelist
 +cols    : Brand, Model, Versions, Device Type, Availability,​ Supported Since Rev_url, Supported since Rel, Supported current Rel,  Instruction Set, Sub Instruction Set, Bootloader, Platform, Target, CPU MHz, Flash MBs, RAM MB, Switch, Ethernet 100M ports_, Ethernet Gbit ports_, Comments network ports_, Modem, VLAN, WLAN 2.4GHz, WLAN 5.0GHz, WLAN Comments_, Detachable Antennas_, USB ports_, SATA ports_, Comments USB SATA ports_, Serial, JTAG, LED count, Button count, Power supply, Device Techdata_pageid,​ Forum topic URL_url, wikidevi URL_url, OEM Device Homepage URL_url, Firmware OEM Stock URL_url, Firmware OpenWrt Install URL_url, Firmware OpenWrt Upgrade URL_url, Comments_
 +filter ​ : Brand=@@Brand@@
 +filter ​ : Model=@@Model@@
 +filter ​ : Versions=@@Version|@@
 +----
 +
 +==== Photos ====
 +/* =====>>>>>​ Standard size for photos: add ?400 to the medialink ​                               */
 +/* When uploading photos, **name them** intelligently. Nobody knows what 20100930_000602.jpg is! */
 +/* e.g. {{:​media:​yourbrand:​yourbrand_yourmodel_front.jpg?​400|}} ​                                 */
 +/* Thanks, your wiki administration - Oct. 2015 */
 +
 +//​Front://​\\
 +**Insert photo of front of the casing**
 +
 +//Back://\\
 +**Insert photo of back of the casing**
 +
 +//Backside label://\\
 +**Insert photo of backside label**
 +
 +==== Opening the case ====
 +
 +**Note:** This will void your warranty!
 +
 +<WRAP BOX>
 +FIXME //Describe what needs to be done to open the device, e.g. remove rubber feet, adhesive labels, screws, ...//
 +  * To remove the cover and open the device, do a/b/c
 +</​WRAP>​
 +
 +//Main PCB://\\
 +**Insert photo of PCB**
 +
 +==== Serial ====
 +-> [[doc:​hardware:​port.serial]] general information about the serial port, serial port cable, etc.
 +
 +How to connect to the Serial Port of this specific device:\\
 +**Insert photo of PCB with markings for serial port**
 +
 +<WRAP BOX>
 +FIXME //Replace EXAMPLE by real values.//
 +</​WRAP>​
 +
 +^ Serial connection parameters\\ for @@Brand@@ @@Model@@ @@Version@@ | EXAMPLE 115200, 8N1 |
 +
 +==== JTAG ====
 +-> [[doc:​hardware:​port.jtag]] general information about the JTAG port, JTAG cable, etc.
 +
 +How to connect to the JTAG Port of this specific device:\\
 +**Insert photo of PCB with markings for JTAG port**
 +
 +===== Bootloader mods =====
 +-> [[doc:​techref:​bootloader]]
 +
 +===== Hardware mods =====
 +
 +None so far.
 +
 +
 +===== Bootlogs =====
 +==== OEM bootlog ====
 +<WRAP bootlog>
 +<​nowiki>​COPY HERE THE BOOTLOG WITH THE ORIGINAL FIRMWARE</​nowiki>​
 +</​WRAP>​\\
 +
 +==== OpenWrt bootlog ====
 +<WRAP bootlog>
 +<​nowiki>​COPY HERE THE BOOTLOG ONCE OPENWRT IS INSTALLED AND RUNNING</​nowiki>​
 +</​WRAP>​\\
 +
 +===== Notes =====
 +//Space for additional notes, links to forum threads or other resources.//​
 +
 +  * ...
 +
 +===== Tags =====
 +<WRAP BOX>
 +FIXME //Add tags below, then remove this fixme.//
 +</​WRAP>​
 +
 +[[meta:​tags|How to add tags]]
 +{{tag>​EXAMPLETAG}}