Template:USB Device Data: Difference between revisions

From LinuxTVWiki
Jump to navigation Jump to search
(→‎Data: added first em2880 device)
(→‎Semantics: added more help for editors)
Line 36: Line 36:
</pre>
</pre>
|-
|-
| "pic" || preferably an image uploaded to the wiki. using 120px width
| "pic" || preferably an image uploaded to the wiki (using 120px width). links to external pictures are ok in a pinch, but those might disappear any time. Some vendors only keep the current devices on their page and every older Device vanishes.
|-
|-
| "url" || url to the manufacturers/vendors page for that device
| "url" || link to the manufacturers/vendors page for that device. but also links to linux user experience pages, forum articles or mailing list achives regarding this device.
|-
|-
| "type" || interface supported. E.g. USB1.1 or USB2.0 (put USB1.1 first if the device supports both)
| "type" || interface supported. E.g. USB1.1 or USB2.0 (put USB1.1 first if the device supports both)
|-
| "hw" || summary of the hardware (human readable)
|-
|-
| "hw" || summary of the hardware (human readable). this will hold the old data during transition and also allow to add hw related information beyond tuner, demodulator and usb bridge.
| "usb id" || usb id (still not sure if we should have this machine readable.
|-
it would mean only one id per entry and could lead to a lot of duplicated entries.
| "usb id" || usb id. 4 hex digits, colon, 4 hex digits. lower case. e.g. <tt>12ba:f001</tt> preferably only add the "cold" id. The one shown before firmware upload. The warm Id should go the the device's page.
|-
|-
|
|
Line 55: Line 54:
| "fw" || firmware name. link?
| "fw" || firmware name. link?
|-
|-
| "comment" || human readable comments
| "comment" || human readable comments. if those comments stretch several lines, it is time to make a device page. :-)
|}
|}




<!-- ****************************************************************** -->
<!-- ****************************************************************** -->

Revision as of 13:41, 30 April 2009


The data contained in this template will sooner or later replace the collection of tables in the DVB-T_USB Devices article.

With the help of the ParserFunctions extention it will also be possible to select subsets of the data for other purposes. E.g. The devices that use a certain tuner or the devices by a certain vendor.


Full Detail Table

Vendor Device/Model Supported Pictures URL Interface USB ID Hardware Tuner Demodulator USB Bridge Firmware Comment E


Semantics

"renderwith" is the template that the data is passed to for rendering (a table row)
"vendor" the device manufacturer/vendor. E.g. Hauppauge
"device" the device name. E.g. Cinergy XXS
"supported" support status.
   {{yes}} or {{no}} if there is no further detail but I'd prefer something like 
   {{Supported_in_Kernel|version=2.6.25}} if supported by vanilla kernel since "version"
   {{Supported_in_HG|since=2009-01-31}} for support in main line mercurial repository
   {{Supported_in_HG_Branch|since=2009-01-31|branchurl=http://linuxtv.org/hg/~anttip/af9015/}}
   {{Supported_in_External|since=2009-01-31|url=http://mcentral.de/wiki/index.php5/Em2880}}
"pic" preferably an image uploaded to the wiki (using 120px width). links to external pictures are ok in a pinch, but those might disappear any time. Some vendors only keep the current devices on their page and every older Device vanishes.
"url" link to the manufacturers/vendors page for that device. but also links to linux user experience pages, forum articles or mailing list achives regarding this device.
"type" interface supported. E.g. USB1.1 or USB2.0 (put USB1.1 first if the device supports both)
"hw" summary of the hardware (human readable). this will hold the old data during transition and also allow to add hw related information beyond tuner, demodulator and usb bridge.
"usb id" usb id. 4 hex digits, colon, 4 hex digits. lower case. e.g. 12ba:f001 preferably only add the "cold" id. The one shown before firmware upload. The warm Id should go the the device's page.
  • "tuner"
  • "demodulator"
  • "usbbridge"
machine readable component names for implementing filters based on this in the future. E.g. af9015, vt7045, mt2060
"fw" firmware name. link?
"comment" human readable comments. if those comments stretch several lines, it is time to make a device page. :-)


Data

Here is a cut'n paste template for new devices.


{{{{{renderwith}}}
| vendor=
| device=
| supported=
| pic=
| url=
| type=
| usbid=
| hw=
| tuner=
| demodulator=
| usbbridge=
| fw=
| comment=
}}