Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing Documentation and BOM #17

Open
mnemocron opened this issue Nov 21, 2020 · 8 comments
Open

Missing Documentation and BOM #17

mnemocron opened this issue Nov 21, 2020 · 8 comments

Comments

@mnemocron
Copy link

mnemocron commented Nov 21, 2020

The project in itself is a very neat thing to build. But can you please add more documentation.
Just from the files alone I was not able to order the correct parts.

The schematics do not give away the exact part-nr. for the components.
This is tricky not only for capacitors but mostly for the electromechanical components like the fuse-clips or the switch.

Furthermore, I managed to order the wrong LCD module - the one from Sparkfun - as opposed to the cheaper Chinese one with a different pinout.
Then I ordered a 1117 Regulator as a THT part because many images online contain a THT regulator.
But the most recent revision of the PCB (v1.2.106) apparently features an SMT regulator.

.. I hope you see my point.
Please add at least a proper BOM with reference to the hardware revision (eg. v1.2.106)

Here is a start. This is what I ordered from digi-key

https://octopart.com/bom-tool/xPA7yJNx

(note: that the BOM is incomplete and does contain extra parts and wrong parts)


Another part you should document is, how you compile and upload the code to the board.
The URL in the README is outdated and does not work anymore.
I used the following commands in WSL to compile the code:

sudo apt install make avr-gcc avr-libc gcc-avr
cd ./code
make

and the following commands in PowerShell to upload the code to the board using USB-ASP connected to the Ethernet SPI

& 'C:\Program Files (x86)\Arduino\hardware\tools\avr/bin/avrdude' -CC:'\Program Files (x86)\Arduino\hardware\tools\avr/etc/avrdude.conf' -v -patmega328p -cusbasp -Pusb -Uflash:w:C:\users\simon\Downloads\uRADMonitor.hex:i

or short

avrdude.exe -Cavrdude.conf -v -patmega328p -cusbasp -Pusb -Uflash:w:uRADMonitor.hex:i

And maybe you could document how the Software works.
What the LCD displays and what the button does.
This is actually covered in the Youtube Video linked somewhere in the repo.

@radhoo
Copy link
Owner

radhoo commented Nov 21, 2020

Hello Simon,

Thanks for the nice feedback.

There are a few articles on the uRADMonitor blog that bring in the missing pieces, see: https://www.uradmonitor.com/blog/?s=kit1

There was also a article on how to compile the KIT1 code but it got deleted with no recovery due to an unexpected situation.

If interested feel free to give back to the community yourself, and write a quick guide or even a blog post on the uRADMonitor blog.

Let me know if interested, that would help others like you with what you learned so far.

@mnemocron
Copy link
Author

Thanks for the hint with the forum. When I was researching my BOM, I quickly left the forum website as it did not seem to contain the information that I need (still doesn't).

I just looked at the articles you linked.
The issue with the articles is: they do not contain a proper BOM.
They either link back to this repo on Github or they contain some sort of "tutorial" for an outdated hardware.

But there is a post that describes how to program it at least (using USB ASP):
https://www.uradmonitor.com/open-source-uradmonitor-kit1/

And a post describing what the firmware does:
https://www.uradmonitor.com/model-kit1-production-ready/

I should not have to research a BOM from some Forum posts that are not linked inside the original repo.

So yes, I would like to share my findings as soon as I have a Kit running. (In a way I already did here)
Unfortunately I now need to order again...
It just feels odd that you encourage me to reverse engineer something that you already know.

@IkaSGC
Copy link

IkaSGC commented Nov 21, 2020

If someone could bring quality instructions on how to put it together and flash using windows, it would be amazing. I have theoretically materials for several uRad monitors at home. I've passed one so far, but I can't get anything out of it. Even the display shows nothing. Obviously an error occurred somewhere, but I can't figure it out with the little information I found.

@radhoo
Copy link
Owner

radhoo commented Nov 21, 2020

Also see: https://www.uradmonitor.com/topic/opensource-kit1-firmware/ and the rest of the forum.

@radhoo
Copy link
Owner

radhoo commented Nov 21, 2020

For compiling on Windows there already is a tutorial here: https://www.uradmonitor.com/a-tutorial-how-to-compile-kit1-firmware-on-a-windows-machine/

@mnemocron
Copy link
Author

mnemocron commented Dec 26, 2020

a wonderful good morning everyone,

I have finished up the BOM on Octopart.
I used the bom.html from the original repository and added actual part numbers (for digikey).

It would be helpful if you could copy / paste the BOM as Markdown or .csv to your Wiki or Readme.md

BOM on Octopart

@mnemocron
Copy link
Author

mnemocron commented Dec 26, 2020

@IkaSGC just an idea. Which LCD Modules do you have?
I actually bought the more expensive Sparkfun modules. But they have the wrong pinout, different from the Chinese ones you find on aliexpress. When I rewired the LCD module with the help of the schematics and some breadboard wires it worked.

@IkaSGC
Copy link

IkaSGC commented Dec 26, 2020

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants