Questions tagged [documentation]

The tag has no usage guidance.

Filter by
Sorted by
Tagged with
48
votes
7answers
4k views

What should a contract Electrical Engineer deliver once a project is complete?

I'm getting ready to hire an electrical engineer for a small contract job - creating a prototype. What I'd like to know is, what should I have him deliver to me when the project is complete? I ...
43
votes
7answers
8k 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 ...
23
votes
6answers
7k 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 ...
16
votes
7answers
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 ...
13
votes
5answers
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
votes
3answers
916 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 ...
10
votes
2answers
4k views

How make hardware documentation?

I'm building some slides for my class about how we should document the hardware we are developing. I'd like to list the documents we should make when building some hardware. I was inspired at UML ...
9
votes
1answer
1k views

What are your best resources for winding custom transformers?

What are the best resources that you have found for winding custom transformers? prose, videos, forums, etc. I am looking for things more on the practical side rather than resources explaining the ...
7
votes
6answers
761 views

Text presentation of a byte

I've seen in a lot of projects a cool presentation of byte such as : Fuse high byte: 0xc9 = 1 1 0 0 1 0 0 1 -- BOOTRST (boot reset vector at 0x0000) ^ ^ ^ ^ ^ ^ ^-----...
7
votes
2answers
3k views

Online guide to electronics [closed]

I had the luck to have someone who could explain everything to me, but most starting hobbyists don't have someone like that. Is there a guide available which covers all the basics, like formulas, ...
7
votes
3answers
435 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 ...
7
votes
2answers
2k 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 ...
6
votes
5answers
466 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 ...
5
votes
7answers
698 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 ...
5
votes
3answers
953 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
votes
2answers
336 views

What documentation should an engineer produce for communicating with other people?

Im soon to be developing a product on my own, for possible or sale or given away(open source as such). But I am struggling with the "internal" documentation that I should produce. What documentation ...
5
votes
2answers
2k views

Learning to read datasheets

As an electronics engineer, I understand one spends a lot of time understanding datasheets. I discovered the skill of reading datasheets is much more difficult than I expected. If anything, a ...
4
votes
4answers
2k views

TI manual naming conventions?

Can anyone shed some light on the naming conventions used by Texas Instruments manuals/guides/documents. For example slaa490, slau337. Is there a pattern hidden? Anyway to tell, just by looking at the ...
4
votes
1answer
2k views

Documentation generator for embedded C projects

I'm looking for the equivalent of what Javadoc is to Java and from that, a way to standardize code documentation. Is doxygen more common in this context. Are there built-in, IDE-dependent options? I'...
4
votes
1answer
1k views

C Documentation for AVR Atmel Studio

I am new to AVR programming and have tried couple of tests on assembly language and were successful. However, I would like to try out programming in C with Atmel Studio. Could somebody tell me where ...
3
votes
2answers
1k 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-...
3
votes
1answer
314 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 ...
3
votes
1answer
155 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 ...
3
votes
1answer
47 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
1answer
160 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 ...
2
votes
2answers
1k 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 ...
2
votes
2answers
114 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 ...
2
votes
1answer
160 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 ...
2
votes
1answer
321 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 ...
2
votes
1answer
510 views

Do we need the CE certification for test series in quantity of 100pcs

We are developing a multimedia application WiFi + Audio out + Mic Input + and few buttons), which we plan to produce in the number of 100 pieces and half of that sell to our aquaintances and the rest ...
2
votes
0answers
24 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 ...
1
vote
1answer
104 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/...
1
vote
2answers
170 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 ...
1
vote
3answers
161 views

Is this capacitor 1.2volt or 5volt rated?

I am having trouble understanding this. The document says that this cap is rated at 5volt, but it says that it will break down above 1.2volts... Can someone please take a look and tell me what they ...
1
vote
1answer
52 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 ...
1
vote
3answers
1k views

Any information on BLS, BLD, HU, etc connectors

There are a few similar types of connectors: BLS, BLD, HU, PHU. They are frequently encountered in electronic devices, but I couldn't find any information on them. Google only finds a bunch of places ...
1
vote
1answer
139 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 ...
1
vote
1answer
429 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). ...
1
vote
1answer
2k views

TSL2591 sensor value calculation

I bought an TSL2591 breakout board and wanted to write driver for my board. After looking at the documentation, i found that i cannot calculate the illuminance value (in Lux) as their was algorithm ...
1
vote
0answers
40 views

Equations of Calculating Bus Transaction Times in usb2

I am relatively new to this field and I come up with these equations in chapter 5.11.3 in the document of the USB2 but I don't know how they are justified specially the constants like ...
1
vote
0answers
28 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 ...
1
vote
0answers
288 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 ...
1
vote
0answers
95 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 ...
0
votes
2answers
92 views

Where to look for logic level of a circuit in the datasheet?

Whenever I pick a chip for my project, I run through the same chore: finding out if its logic levels match what I work with. Is it 5V? 3.3V? 1.3V? Or one of these that sources whatever level I apply ...
0
votes
3answers
1k views

How to interface with LCD display - HYeLCD, HC20216NYU

I am trying to drive a small (20x2) LCD screen from a Parallax Propeller board/chip. Can't find a decent manual anywhere. This is the LCD: http://www.jameco.com/1/1/24982-hc20216nyu-lyvo-20-2-black-...
0
votes
3answers
6k 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 ...
0
votes
2answers
36 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%...
0
votes
1answer
89 views

info for RTC module needed

I have this RTC module by MikroElektronika: I need a schematic and/or user manual but it's no longer on the MikroElektronika website. (There's a similarly looking PCB but it uses a different IC than ...
0
votes
2answers
192 views

Arduino Proto Shield Kit

I have this proto kit shield - to make the history short, I bought long time ago, didn't touch it and I "found it" back today. What I didn't find was a tutorial, assembly instructions or even a ...
0
votes
2answers
119 views

Where can I find good documentation about memories?

I'm learning about the different kinds and functionalities of electronic memories (i.e. ram, flash, etc) but I'm a little confused because all the sources show something different and I don't know ...