bluerobotics / bluerobotics.github.io

Blue Robotics product documentation site.
http://docs.bluerobotics.com
Creative Commons Attribution Share Alike 4.0 International
40 stars 37 forks source link

Bar30 Arduino Tutorial #123

Closed dheideman closed 5 years ago

dheideman commented 5 years ago

Adds a tutorial for communicating with a Bar30 with an Arduino. The tutorial is located at: localhost:4000/bar30/bar30-arduino

state: first draft

To Do:

kklemens commented 5 years ago

@dheideman I would add a comment/note/warning on why you can't plug into the 3.3V power right next to the 5V power on the Arduino.

@rjehangir The rest looks good. Do you think we should retake the photos in our small photobooth?

dheideman commented 5 years ago

@kklemens I've clarified/elaborated on some of the explanations, including the note about the 5 V supply to the Level Converter, and added notes about soldering the header pins to the Level Converter.

I also added links to important store pages.

I will hold off on annotating the pictures until we decide what to do about the pictures themselves. I will work on a quick 3D-printed light diffuser in the meantime.

kklemens commented 5 years ago

@dheideman Thanks for clarifying the steps, makes more sense to me now.

dheideman commented 5 years ago

@kklemens I forgot about the links. I feel the links from within the docs should be included in this PR.

Other than the Bar30 page, where do we want to add links? On the docs index page?

dheideman commented 5 years ago

I plan to look at lights for taking nicer pictures this weekend. If the current pictures are sufficient in the interim, I am comfortable with merging this branch (once the links have been handled) and I can put in a PR for improved pictures at a later date.

rjehangir commented 5 years ago

@dheideman We reviewed this with everyone today and have some more feedback. First off, we're thinking that we might get a consistent background to use for all tutorials, maybe a nice wooden cutting board or something that will be consistent. That coupled with a few lights would provide some consistency between you and us.

Also, there is some example Arduino code on the main Bar30 docs page right now. I think we should merge that into your tutorial and eliminate it from the page (and eliminate the page altogether eventually). I think having the base example code on your tutorial would be nice anyways.

Here's where that is right now: http://docs.bluerobotics.com/bar30/#arduino

Can you work on that and the pictures?

dheideman commented 5 years ago

@rjehangir Because some things are better shown with pictures taken from the side rather than solely from the top, I am afraid that a consistent background (other than pure white) will be difficult to achieve, as we would need both a consistent table surface and background.

Personally, I really like the backgrounds that Applied Science uses (his workbench with various equipment in the background), as it makes difficult things appear to be more doable because he's doing it all in his homemade lab. However, this would be pretty much impossible to make consistent between the office and my apartment.

As for the lights, I am working on procuring some. I think three or four LED bar lights with clouded covers should provide a diffuse enough light source. I have one light bar, but the store I got them from is out of stock until at least next week. They're only ~$10 each. I am also working on a simple frame to hold the lights in place.

The example code on the Bar30 docs page is a mildly simplified version of the code on GitHub. There is nothing code-wise on that page that we don't already have, so removing it would be perfectly fine. I can put the example code on the tutorial page, as that could definitely be helpful to readers, but I do not feel comfortable putting a different version from that which is on GitHub in the tutorial.