Questions tagged [documentation]
Documents which explain the function(s), use, limitations, specifications, etc. of an electrical component. Examples include datasheets, schematics, user manuals, etc.
72
questions
2
votes
1
answer
77
views
How are register detail figures made for IP/peripheral documentation?
How are the register detail figures made for documentation of things like Xilinx/Vivado IP or in documentation for memory-mapped peripherals in microcontrollers like the examples below?
Xilinx IP ...
2
votes
0
answers
34
views
Specification of Electrical Cable List Documentation [closed]
Up to date, I have found the following specification for building an Electrical Cable List in engineering projects for facilities involving electrical and instrumentation equipment and major ...
- 1,409
0
votes
1
answer
21
views
NINA-B30 series registers pdf
I want to know the register map/registers of the NINA-B30 series ICs, as I am used to writing low-level drivers on MCUs.
I could not find the datasheet that lists all the registers and their function ...
- 2,779
8
votes
3
answers
757
views
How to correctly fill a BOM with split connectors
I have to prepare the documentation for production.
In our board we use a specific female header with 6 positions.
Long story short, the buyer guys told me we will buy a 64-way connector and then it ...
- 1,160
0
votes
1
answer
100
views
Somebody who own MSP432P401R User Guide?
Is there somebody, who can deliver me the user guide for MSP432P401R? I know, this question looks dummy. However the mentioned part lost support from the side of Texas Instruments, and they cannot ...
- 21
0
votes
1
answer
675
views
Metal detector circuit description
I found a circuit for this metal detector and would like to make PCB. I can not find anything about this circuit. Maybe someone would know what this circuit is. What are the best component housings to ...
- 1
0
votes
1
answer
239
views
Choice of mosfet transistor for linear operation (voltage controlled dummy load / current source)
BACKGROUND
I have built very simple dummy load to test thermal behavior of some switching power supply (5V 5A). Vbat is 8-9V from 6F22 battery. Resistors are oversized to reduce working temperature.
...
- 5,926
7
votes
2
answers
730
views
What does apostrophe mean for a register description in a datasheet e.g. 4'd5?
The datasheet lists something like this:
[0x01f] EPRXREG
EPRXLock[3:0] = 4'd5;
EPRXReLock[3:0] = 4'd5
I understand that it is an 8-bit register at address ...
- 227
0
votes
1
answer
63
views
Looking for all-encompassing website to download standards (UL, NEC, ISO, etc) [closed]
TLDR : Frustrated with the way standards are handled in my industry bc they are important, looking for one website that does it all.
I am a controls engineer and have been in this industry for about 7 ...
- 103
0
votes
2
answers
87
views
Where can i get the actual implementation of component diagrams?
is there a place where i can get the actual implementation of a component diagram such as the one below?
Usually the tutorial are high level and dont provide any details of how the connections are ...
- 81
0
votes
0
answers
92
views
How do you do Electro-mechanical Assembly Documentation?
I realize this isn't specifically EE theory related, but I hope EE documentation advice falls within the scope of this forum!
For example, I have an enclosure from a mechanical engineer, and their ...
- 5
1
vote
0
answers
72
views
Is there a built in program in any of the top EDA software to ease production of Technical Publications?
I have been assigned to design a PCB and now I have to create Technical Documentation for in-house use. I tried googling this information but it shows the documentation for the software which is not ...
- 182
2
votes
0
answers
26
views
How to correctly document wireless network choice for a project?
Disclaimer: I have limited wireless knowledge at the moment, I'm currently following the Certified Wireless Network Administrator study guide.
I'm working on an RC car and have the following network ...
- 21
0
votes
2
answers
86
views
Interpreting a voltage requirement given both as a range and as a percentage?
The following table contains the input power specifications for a laser printer:
(Source page 1-9)
As you can see, the volts listing is given both as a range, "100-127" and also as a percentage "±10%...
- 1,226
1
vote
0
answers
68
views
What is the pin configuration of an Hitachi HN46532-2 Mask ROM?
I'm working remotely with a person that has a Canon BX-1 computer from around 1978. He has the computer and I have fuzzy memory of the machine. There is no hardware documentation to be found, so we ...
- 139
3
votes
1
answer
70
views
Details about Total Access Communication System (TACS)
I'm not sure if this is the right place to ask.
I am trying to build a base station for a TACS (Total Access Communication System) phone, but I have not found any detailed document about it. The most ...
3
votes
2
answers
6k
views
How to draw digital timing diagrams for documentation?
I have read through many electronics documentation over the years and I have really wanted to draw the timing diagrams for digital signals using some software.
I have seen https://wavedrom.com/...
- 31
5
votes
7
answers
2k
views
Convention for inverted signal
Is there a standard convention for marking an inverted signal using only text? The package currently being used does not support having a bar over the signal in all instances.
IE: NOT_Reset or ...
- 1,092
0
votes
0
answers
98
views
How to prevent solder getting into through hole during HASL process?
I think this is an easy enough question - I just don't know how to effectively search for the answer.
I have a PCB that came back and the programming header is plugged with solder. This most likely ...
- 11.9k
5
votes
3
answers
1k
views
Recommended PCB layout understanding - ADM2572 datasheet
I have problem with understanding and applying this recommended PCB layout to my design (image from datasheet, page 18):
This is isolated RS485 transceiver with integrated isolated high frequency DC-...
- 5,926
0
votes
1
answer
65
views
Some schematic voltage values (physical names) missed when printed or generated in Altium
Maybe it's a silly issue, but the fact is that I don' t know why a voltage value is present in the schem project document but it will disappear from the destination document (printed or generated) at ...
- 787
0
votes
1
answer
1k
views
What is RSS Error?
I was reading through documentation for an INA219 sensor from TI (http://www.ti.com/product/INA219), and they have a chart for RSS Error.
What does RSS stand for?
- 143
1
vote
2
answers
384
views
How to generate board plot/image in Eagle
I designed my own PCB in Eagle so I have both the schematics and the board files.
I would like to generate a figure like this one made for Arduino board in order to include it in the user manual that ...
- 171
0
votes
1
answer
170
views
Compatibility of an LCD module and a connector
I want to realize i2c communication myself using Raspberry Pi and a LCD module.
I am reading documentations to find an appropriate connector but I am a bit confused and I need help.
Here is the LCD ...
- 119
3
votes
1
answer
292
views
Is there any single-board computer/system-on-a-chip with good documentation for developing bare metal? [closed]
I always wanted to develop my own crappy operating system, but the many weird legacy quirks of the x86/PC platform kept me from doing so (e.g. real vs protected mode, only low resolutions available in ...
- 165
0
votes
1
answer
94
views
controlling some RGB LED modules with HD74HC254P and 74HC595N ICs
I got some LED modules dismantled from old festival screen. It would be nice to get them working, but I can't find any info about them, neither I have any idea how to controll them. AFAIK they are ...
- 123
5
votes
2
answers
4k
views
How to add items to Schematic and BOM without footprints in the PCB in Altium
As part of the documentation for an Electronics project generated in Altium designer 17, I would like to add part number for items the project need, but are not part of the PCB.
For example in the ...
- 3,169
1
vote
1
answer
67
views
Presenting Built-In Self-Test Coverage
I have a piece of code that performs self-test on various components of the board, like MCU, BLE, IMU, OLED, flash memory, and etc.
What I'm trying to make is a document that would represent what ...
- 142
2
votes
1
answer
349
views
Altium Designer 16 - CurrentDate Special String Format
In previous projects, I used the CurrentDate special string, in the format YYYY-MM-DD (see the image below).
Opening the same project on a different installation ...
- 1,600
3
votes
2
answers
3k
views
What does the abbreviation U.FL-LP connector stand for?
I am writing up a document on a product that includes some U.FL-LP connectors. I try to always put the full version of abbreviations when they are first mentioned and I assume U.FL and LP in the U.FL-...
- 145
13
votes
5
answers
3k
views
Why put unpopulated components on a BOM?
I've ran into quite a few engineers from unrelated backgrounds that put unpopulated components on the BOM. Some will do a section clearly labelled DNP at the bottom, others will leave them dispersed ...
- 13.7k
2
votes
3
answers
12k
views
Lack of documentation on batteries? Trying to understand why LR1130 and LR1131 aren't equivalents
Recently I purchased some AG10 button cells for a device I have. The device specifically calls for LR1131 batteries, but someone online told me that AG10 was equivalent (and they are in a way: same ...
- 23
0
votes
1
answer
509
views
LabView drivers for Keithley 6487. where to find documentation?
I have to set up a program for measuring the IV characteristics of some components using LabView.
At the time of writing I'm studying the basics of the G language (LabView programming language) for ...
- 1,060
1
vote
1
answer
180
views
Venus GPS 1PPS configuration
I have a Venus634LPx GPS on a breakout board from SparkFun. Read more about it in my previous question.
The configuration program gives me the option to configure "1PPS Timing":
Here I can choose ...
- 163
1
vote
1
answer
632
views
GPS pinning parameters
I have a Venus634LPx GPS on a breakout board from SparkFun.
The documentation is very cryptic, so I did not manage to configure it manually through the UART (although I can read data from it). ...
- 163
2
votes
2
answers
160
views
How to document protocol changes across firmware
I have updated the firmware on my device to accept new commands. How do I make it clear to other developers that the new protocol document is specific to this recent version?
Should I make it clear ...
- 411
2
votes
1
answer
467
views
How should entites and architectures in VHDL be commented?
How should an entity and an architecture be commented in VHDL to best be used with Doxygen?
Im trying to use Doxygen to generate useful documentation for my VHDL, but im not sure of the best way to ...
3
votes
1
answer
222
views
What does the flag formula symbols mean in AVR assembler documentations
I was reading about something in the assembler documentations of the AVR microcontroller and I usually come across a line used to describe how would an instruction affect specific flag in the status ...
- 527
1
vote
0
answers
427
views
What do ARM revisions mean? e.g. r2p1
Questions
What do the "revisions" mean in the processor documentation at the ARM Information Center?
Do they refer to silicon processor core design revisions, documentation revisions, or ...
- 522
1
vote
0
answers
122
views
Where to find most of datasheets?
I am trying to find a datasheet for one of the following cores: BCM11311 or bcm21654.
Which have an ARMv7-A architecture and ARM cortex 9 processor.
However I am completely unable to find any usefull ...
- 65
13
votes
3
answers
1k
views
What is *actually* a *standard part*?
This is something that has bothered me for ages. I wasn't sure it could be made up as a question here, until Olin Lathrop suggested it to me in a comment to another thread.
We all know what we are ...
7
votes
3
answers
494
views
How do you document bodges?
After making the PCBs, we decided on some bodges and implemented them on the PCBs. What's the standard way to document that on the schematics?
For now, I hand drew with the mouse, paint style, on ...
- 649
7
votes
2
answers
3k
views
Best practices in making cable schematics
I would like to make cable schematics for manufacturing that would include:
cable lengths
connectors
pins
conduit length
heat shrink tube length
and have a BOM for that automatically generated in ...
- 487
0
votes
3
answers
2k
views
JEDEC Flash Command Set
I am attempting to use a SPI NOR flash memory IC that is said to support CFI (Common Flash Interface) and the JEDEC flash command set. This sounds great however I have been unable to find any ...
- 288
16
votes
7
answers
2k
views
What process do you use to ensure your PCB works on the first try? [closed]
What are the best practices for catching stupid mistakes vs more subtle ones? Do you run over a checklist of things for each design? If so, what kinds of things are on it?
I'm interested in ...
- 1,660
6
votes
5
answers
491
views
Best practice for documenting ports / peripherals?
I've recently taken an interest in embedded development and am wondering how most people document their projects. For example:
Each pin on PORTE is wired to ...
- 260
25
votes
6
answers
8k
views
How to Transition from "Basic" Microcontrollers to ARM Cortex?
I have many years of experience with 8-bit cores from various manufacturers - namely 8051, PIC, and AVR - and I now have a Cortex M0 to figure out. Specifically this one, but I hope we can be more ...
- 5,646
3
votes
1
answer
349
views
Is there a correct way to document RoHS compliance?
I work for a small electrical engineering company. Our products are not presently RoHS, but we're planning to switch over. As best I can tell, this is a matter of ensuring that our individual ...
- 17.4k
0
votes
1
answer
212
views
Depicting Analog Signal Paths graphically
Is there a 'standard' way to depict analog signal pathways / chains that's simple, concise, and not too mathematical?
I've been searching online, but can't seem to figure out what such a diagram is ...
- 2,241
46
votes
7
answers
9k
views
How do you document your hardware design decisions?
How do you document your hardware decisions in the design phase?
How do you avoid having to ask yourself the following questions while reviewing an hardware design that you made in the past:
Why did ...
- 10.7k