Example Device: Difference between revisions

From Caps Wiki
Jump to navigation Jump to search
No edit summary
m (clarify board markings)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{WikipediaInfoAlt|Device}}
<blockquote>If there is a page on Wikipedia for the device you can link to it with the template above, if not you can delete it</blockquote>


{{InfoboxDevice
{{InfoboxDevice
|Title = New Device
|Title = New Device
|Picture =  
|Picture = Caps-Wiki-Example-PCB.png
|Release Year = 1980
|Release Year = 1980
|Mounting Technology = Through Hole, SMD, BGA, Sockets
|Mounting Technology = Through Hole, SMD, BGA, Sockets
Line 13: Line 15:
This is an example page for creating new pages for devices so users know what can be done when creating a new page.
This is an example page for creating new pages for devices so users know what can be done when creating a new page.


<blockquote>Up top is just a basic description of the device so people know what the page is for. You can add whatever general details you want here but keep in mind that linking to a full wikipedia page for more information would be fine rather than duplicating it here.</blockquote><blockquote>On the right is an "InfoBox". It is used to give a brief summary of the device before getting into the contents of the page. The main goal is to convey if the device would benefit from being worked on before showing signs of issues due to potentially leaking batteries or capacitors. It can also have information that will let users know how difficult the device will be to work on. The destructive entry section is specifically to let users know if the device is permanently assembled with things like plastic rivets or sonic welding that must be broken. Adhesives aren't quite destructive but may be mentioned there as a quick warning.</blockquote>
<blockquote>A basic description of the device so people know what the page is for. You can add whatever general details you want here but keep in mind that linking to a full wikipedia page if available for more information would be prefered rather than duplicating it here.</blockquote><blockquote>On the right is an "InfoBox". It is used to give a brief summary of the device before getting into the contents of the page. The main goal is to convey if the device would benefit from being worked on before showing signs of issues due to potentially leaking batteries or capacitors. It can also have information that will let users know how difficult the device will be to work on. The destructive entry section is specifically to let users know if the device is permanently assembled with things like plastic rivets or sonic welding that must be broken. Adhesives aren't quite destructive but may be mentioned there as a quick warning.</blockquote>


==Known Issues==
==Known Issues==
<blockquote>This section should be used to go over the stages of troubleshooting known issues. For example, an IBM 5150 may not turn on, it could be caused by a shorted tantalum overdrawing current from the power supply, replacing or removing the tantalum will fix it. Using the cite feature to link to a video or forum thread on this would be extremely helpful for users to read more into it. But anecdotal information is welcome if it will be helpful to users.


*Symptom or Problem Encountered
If you only know a solution to a problem or only know the cause still feel free to put that information in and delete the empty section. Limited information can still be helpful and make intrigue someone into investigating more.</blockquote>
**Description of cause
***Solution: Solution to the problem
<blockquote>This section should be used to go over the stages of troubleshooting known issues. For example, an IBM 5150 may not turn on, it could be caused by a shorted tantalum overdrawing current from the power supply, replacing or removing the tantalum will fix it. Using the cite feature to link to a video or forum thread on this would be extremely helpful for users to read more into it. But anecdotal information is welcome if it will be helpful to users.</blockquote>


==== Symptom or Problem Encountered ====
===== Cause =====
*Description of cause
<blockquote>If you have pictures of the cause you can put them here in a gallery so they appear next to the description</blockquote>
==== Solution ====
*Solution to the problem
==Disassembly Notes==
==Disassembly Notes==
Warnings or tips to disassemble then device   
Warnings or tips to disassemble then device   
Line 28: Line 36:


==Original Parts==
==Original Parts==
<blockquote>This area is more technical and is intended to catalog accurate information about devices for future reference.
<blockquote>This area is more technical and is intended to catalog accurate information about the original parts in devices for future reference. Please note this table is very specifically for documenting that parts that '''originally''' came in the device. This is meant to be a concrete record of what is in an unmodified example of the device. Values of replacement parts should not be used to fill in this section and instead go below.</blockquote>


The "Basic PCB Name" should be used to describe what the PCB is if the device contains more than one or if there are multiple revisions. If a device has multiple PCBs or revisions please note any part numbers, revisions, or general descriptions on them that you can below the table. Different PCBs should be listed on different tables as RefDes's will likely be reused on them.
===Basic PCB Name===
<blockquote>The "Basic PCB Name" should be used to describe what the PCB is if the device contains more than one or if there are multiple revisions. If a device has multiple PCBs or revisions please note any part numbers, revisions, or general descriptions on them that you can below the Basic PCB Name. Different PCBs should be listed on different tables as RefDes's will likely be reused on them.


For example, a Commodore PET has multiple circuit boards in it and may share some between different model configurations. There may be a table for the video board and the logic board. The logic board also differs between different revisions of the computer and would have multiple tables. Something like a Commodore 64 has just one board but would have many different models and revisions that are all similar enough to go on one page but don't have all the exact same parts on them.
For example, a Commodore PET has multiple circuit boards in it and may share some between different model configurations. There may be a table for the video board and the logic board. The logic board also differs between different revisions of the computer and would have multiple tables. Something like a Commodore 64 has just one board but would have many different models and revisions that are all similar enough to go on one page but don't have all the exact same parts on them.


For right now copying the heading and table and replacing the data in it is the easiest way to add more of them. Methods for making table templates are still being researched to make editing easier.</blockquote>
For right now copying the heading and table and replacing the data in it is the easiest way to add more of them. Methods for making table templates are still being researched to make editing easier.</blockquote>
{| class="wikitable"
|-
|}


===Basic PCB Name===
''Note model numbers and board revisions here''<blockquote>Any markings or numbers on the PCB that could be used to indicate which board or what revision it is should go here. These are usually in the silkscreen on the PCB or etched into the copper.</blockquote>
{| class="wikitable"
{| class="wikitable"
|+Capacitor [[Capacitor Specifications|Specifications]] and Footprint [[Part Footprints|Information]]
|+Capacitor [[Capacitor Specifications|Specifications]] and Footprint [[Part Footprints|Information]]
Line 59: Line 72:
|
|
|
|
|}
|}<blockquote>Since capacitors are such a common culprit of issues tables are included for those by default. If you need to mark down other parts feel free to make new tables to hold that data. Just be sure to mark down enough information about the parts to be able to order replacements. 
 


''Note model numbers and board revisions down here''<blockquote>
Please note this table is very specifically for documenting that parts that '''originally''' came in the device. This is meant to be a concrete record of what is in an unmodified example of the device. Values of replacement parts should not be used to fill in this section and instead go below. </blockquote>


If you don't know what the capacitor series is feel free to write down any markings on the capacitors in the "Series" column and make a note below the table that you aren't sure what they are. Someone else may be able to look at the markings you write down and identify the series. </blockquote>
==Replacement Parts==
==Replacement Parts==
===Individual Components===
<blockquote>This is the main even for these pages that will give users the information on what they need to repair devices. While it would be preferred to have both this and the original parts list there are going to be times where only the replacements parts will be known. It is okay to put those down here because that will still help people in repairs. Be sure to note the "Basic PCB Name" so it is known what board is being worked on and you can see more information in the section above on why it matters.</blockquote>
 
===Basic PCB Name===
{| class="wikitable"
{| class="wikitable"
|+Capacitors
|+Capacitors
! [[#Basic_PCB_Name|Basic PCB Name]]
! RefDes
! RefDes
! Qty
! Qty
Line 74: Line 88:
! Order Links
! Order Links
|-
|-
|
|
|
|
|
Line 80: Line 93:
|[https://www.digikey.com/ Digikey]
|[https://www.digikey.com/ Digikey]
|}
|}
''If parts are not available or different selection is preferred, you can use the values in the [[#Original_Parts|Original Parts]] section to perform a parametric search.''
<blockquote>Rather than list out all of the information about replacement part, providing the model number and linking to where it can be purchase will give users all the information they need. The only things that need to be mentioned here are the RefDes' the parts go to, the quantity is only there to make it easier to see how many there are in cases of things like decoupling caps where there may be dozens of them.
 
If you have a link to another distributor for the same part feel free to also put them in the order links cell. Links to save searches are also welcome. If there is enough information. it may be worth making the table more advanced like the [[Voodoo 5]] page to give users the most options</blockquote>


===Kits===
===Kits===
*Digikey BOM: https://www.digikey.com/
*Digikey BOM: https://www.digikey.com/
<blockquote>If you have a link to a kit for multiple parts for the PCB or device provided by someone or as a parts BOM through a distributor feel free to put them here. There is an irony in linking homebrew kits because the entire purpose of this site is to demystify what is needed to repair things but those options have their purpose at times so they are still welcome. Note that this isn't a place for advertising, so do not editorialize different options as "better" or "cheaper", just provide a basic description of the source.</blockquote>


==Related Media==
==Related Links==


*[https://www.youtube.com Videos or other things that might be helpful to check out]
*[https://www.youtube.com Videos or other things that might be helpful to check out]
<blockquote>Any websites, manuals, videos, forum threads, Discord servers, IRC channels, or other things that contain information about the device can be linked here for further reading. Again, this is not a section for editorializing so just provide basic descriptions of what the link goes to.
If you did the repair yourself and want to show other's how you did it you can feel free to put a video link here for others to see how it is done</blockquote>


==References==
==References==
<references />
<references /><blockquote>This area is automatically populated when you use the Cite feature and doesn't need to be modified. Use the Related Links section above if you want to provide more references. </blockquote>

Latest revision as of 13:37, 10 March 2022

For more information, see this article's corresponding Wikipedia page: Device.

If there is a page on Wikipedia for the device you can link to it with the template above, if not you can delete it

New Device
Preliminary Information
Release Year 1980
Leak Risk Medium
Batteries None
Mounting Technology Through Hole, SMD, BGA, Sockets
Capacitor Types Aluminum Electrolytic, Tantalum, Ceramic, Polymer
Destructive Entry No

This is an example page for creating new pages for devices so users know what can be done when creating a new page.

A basic description of the device so people know what the page is for. You can add whatever general details you want here but keep in mind that linking to a full wikipedia page if available for more information would be prefered rather than duplicating it here.

On the right is an "InfoBox". It is used to give a brief summary of the device before getting into the contents of the page. The main goal is to convey if the device would benefit from being worked on before showing signs of issues due to potentially leaking batteries or capacitors. It can also have information that will let users know how difficult the device will be to work on. The destructive entry section is specifically to let users know if the device is permanently assembled with things like plastic rivets or sonic welding that must be broken. Adhesives aren't quite destructive but may be mentioned there as a quick warning.

Known Issues

This section should be used to go over the stages of troubleshooting known issues. For example, an IBM 5150 may not turn on, it could be caused by a shorted tantalum overdrawing current from the power supply, replacing or removing the tantalum will fix it. Using the cite feature to link to a video or forum thread on this would be extremely helpful for users to read more into it. But anecdotal information is welcome if it will be helpful to users. If you only know a solution to a problem or only know the cause still feel free to put that information in and delete the empty section. Limited information can still be helpful and make intrigue someone into investigating more.

Symptom or Problem Encountered

Cause
  • Description of cause

If you have pictures of the cause you can put them here in a gallery so they appear next to the description

Solution

  • Solution to the problem

Disassembly Notes

Warnings or tips to disassemble then device

Things here could be summarized as "I wish I knew this before..." and is meant to serve as warnings or tips to users before they open or work on the device. For example, the Toshiba CT-50 is infamous for having brittle plastic that crumbles apart. A warning to be gentle would be helpful. Other things like screws under rubber feet or stickers, parts that are glued together, or specific spots for plastic snaps would all be great to point out. Images are very welcome in this section.

Original Parts

This area is more technical and is intended to catalog accurate information about the original parts in devices for future reference. Please note this table is very specifically for documenting that parts that originally came in the device. This is meant to be a concrete record of what is in an unmodified example of the device. Values of replacement parts should not be used to fill in this section and instead go below.

Basic PCB Name

The "Basic PCB Name" should be used to describe what the PCB is if the device contains more than one or if there are multiple revisions. If a device has multiple PCBs or revisions please note any part numbers, revisions, or general descriptions on them that you can below the Basic PCB Name. Different PCBs should be listed on different tables as RefDes's will likely be reused on them.

For example, a Commodore PET has multiple circuit boards in it and may share some between different model configurations. There may be a table for the video board and the logic board. The logic board also differs between different revisions of the computer and would have multiple tables. Something like a Commodore 64 has just one board but would have many different models and revisions that are all similar enough to go on one page but don't have all the exact same parts on them.

For right now copying the heading and table and replacing the data in it is the easiest way to add more of them. Methods for making table templates are still being researched to make editing easier.

Note model numbers and board revisions here

Any markings or numbers on the PCB that could be used to indicate which board or what revision it is should go here. These are usually in the silkscreen on the PCB or etched into the copper.

Capacitor Specifications and Footprint Information
RefDes Qty Capacitance Voltage Mount Diameter/Size Temp Type Brand Series

Since capacitors are such a common culprit of issues tables are included for those by default. If you need to mark down other parts feel free to make new tables to hold that data. Just be sure to mark down enough information about the parts to be able to order replacements.


If you don't know what the capacitor series is feel free to write down any markings on the capacitors in the "Series" column and make a note below the table that you aren't sure what they are. Someone else may be able to look at the markings you write down and identify the series.

Replacement Parts

This is the main even for these pages that will give users the information on what they need to repair devices. While it would be preferred to have both this and the original parts list there are going to be times where only the replacements parts will be known. It is okay to put those down here because that will still help people in repairs. Be sure to note the "Basic PCB Name" so it is known what board is being worked on and you can see more information in the section above on why it matters.

Basic PCB Name

Capacitors
RefDes Qty Compatible Part Number Order Links
Digikey

Rather than list out all of the information about replacement part, providing the model number and linking to where it can be purchase will give users all the information they need. The only things that need to be mentioned here are the RefDes' the parts go to, the quantity is only there to make it easier to see how many there are in cases of things like decoupling caps where there may be dozens of them. If you have a link to another distributor for the same part feel free to also put them in the order links cell. Links to save searches are also welcome. If there is enough information. it may be worth making the table more advanced like the Voodoo 5 page to give users the most options

Kits

If you have a link to a kit for multiple parts for the PCB or device provided by someone or as a parts BOM through a distributor feel free to put them here. There is an irony in linking homebrew kits because the entire purpose of this site is to demystify what is needed to repair things but those options have their purpose at times so they are still welcome. Note that this isn't a place for advertising, so do not editorialize different options as "better" or "cheaper", just provide a basic description of the source.

Related Links

Any websites, manuals, videos, forum threads, Discord servers, IRC channels, or other things that contain information about the device can be linked here for further reading. Again, this is not a section for editorializing so just provide basic descriptions of what the link goes to. If you did the repair yourself and want to show other's how you did it you can feel free to put a video link here for others to see how it is done

References

This area is automatically populated when you use the Cite feature and doesn't need to be modified. Use the Related Links section above if you want to provide more references.