From 7d352360d959c2db4ea76a79ba3f1acb30223905 Mon Sep 17 00:00:00 2001 From: pyr0ball Date: Fri, 10 Jan 2020 19:34:04 -0800 Subject: [PATCH] added docs for wiring up UART and uploading firmware #docs --- .../other/USB-UART-Wiring-Example.pdf | Bin 0 -> 6659 bytes .../other/uart-programmer-wiring.md | 5 ++ .../beta-unit-firmware-update.md | 65 ++++++++++++++++++ mkdocs.yml | 3 + 4 files changed, 73 insertions(+) create mode 100644 docs/schematics/other/USB-UART-Wiring-Example.pdf create mode 100644 docs/schematics/other/uart-programmer-wiring.md create mode 100644 docs/tutorials/firmware-update/beta-unit-firmware-update.md diff --git a/docs/schematics/other/USB-UART-Wiring-Example.pdf b/docs/schematics/other/USB-UART-Wiring-Example.pdf new file mode 100644 index 0000000000000000000000000000000000000000..737afaebbfb4e8de2388cbc4101a378b8466297e GIT binary patch literal 6659 zcmZvB2Uru?_jXi@1cXH?q9C!*O9;Iq(xgZPM0yiKCxH+MMMMNesRE%%69g%t7m*?$ z(j*AdTWCT6>Age#!CiOv`|US*=DGKtIp^H>ymMzJ^A5*-WmN%)pePUm5&|I}IRa&6 zf#3%YC}$Xm`-BM42j~Ir00c;_B0v}LfYdVpH~^5O9S*P~jZ^?$04snCz!l&OfB^&n z?f`3mJr5A9goIh45XfISR7kOE04|n=8Qk zS9UvqJpe_rnR1g7n(~l(5R$JX=_f$)75X&-k@9+wybu5zQdW0>6M&!Or%uXi4G<(@ zxQ|5Gcv!>!1flaQ-RV@PQ;PnE=zxGLTcJp`DoYCs2@459AVLr+VR2ze0U=2)At5dv zpu9W~2Ddq7M)=4XdMMI_K(L-7 z2!-@G?c4(i2?_}V!PZtFh@cROJHRnB0xQEj9jsxxYIn?jgBJe}hEuGkh>MzJ(B?KHr8oGldew6^$g}EaFObQpK|)FxBn}Za`&a3wVZT?C62cjQ)N{46hJj8O z*L@{DSI{YTT~eu}?mwV^jqQFL)R0!*ry0S2llCiIP0tE+O6)J9|E`>r_|#RERL7~; zY2Og~$Ps4!d-xA+ziK$eW&-+~rPH#1!_|Vp?NIh0$v+XQIyjT41%XwaNoP$NW{t3c zoo07OkrucM&?~vXR3&j#d%3oaM)*oB&@zmd*UYzP8ZV?pBiHk)=3d9Y9zj^%vk<@Y=V^n|mn-l7ZYkObX z2-}OJI7CtXr=x?7#eIuIV(lRIXmcmpNrQY%A~5D?RU)FwDr|ofSAX(z8|s{ zZ$gHNWtv0)SH*i3ZQ96@O|Vu3m?>^c59%E$YH;|+$>Lyr?NNto-BIeg#gqN`cv*Ae zu2}ua=Kfs01#x+zcX83bZmS#m^suvaOMdp&(J}$|oCTJT(jmK~k;|L~PA})g)a?ZL zDqzOZGHU=??enb(jII>50EMVqakqPz*#tz<7`~o63Wl) zCff&UHMS`|=+t6jcJX(})aB7*?y@R>nBZ>GI*R(a$#EcU1+co`c=yJv>NHi=g4C9S zvSqMpyV&cRP<@!&NzOQ!8vsQbb?NZ zH$`gWa9-==+wy9#Fr z3;B{J)s(MpD{PU++tN zKF5hx;k>SE8|-l3DW+@5sIxFpZr-VgDuu#z{5a!0Cng2l-l0P&q8`W5(P@*P?(dwN zA$Q)t?ZU?-0hv-xfOhYnB4a2%8;QMyc%TqZBg3nnnMO-7%i&Qqtg+50%8`ug7l-E)(-8;7Q>`|~4IG)w&y^|#2C;=~N zM}=utdeg7ZX!W|sjJnUq+)ZSAuUJsNcxyzw zjqc^cvp{Lgw>WE6?-?D33j8{j&xHKa2V*K4j3cARq(iJY-$SOBqO8#;t+Wz@irIZf zcT4ipT$(!oo?WC1A!7SDpz+GBX2-QvIsMe-5L73RT}<_r(zuJ~L^RBlcp7ge+^1bs zq37?{YJX+gxIfbnd=u6vEW@MUz|}p{!g4roe>UmX7v-Me_G?~``lPb8sNJ zy5po&mo#B{nb$Ge3h!M}6+fGV#WaL#>gO7Oxm+m?9h;Qxi7AfVXP4Yi8kAZoN|RDK z#HF{)!q|2wrM9hs$?>yAvG@6t-(+lN8;5|&m+6OI7w*esXR4YoTUB_tu{x9Exec~B zDyBPH@X7TetuBSLJNJ^$ZtZqkKTZ?0%Tr)`^OM;6Fq!8Qf4tV~Z>gPHS9#3jsosmY z>r^M-r4Xr|w!wf?9jofk2a~J*eEQ`?8hfbU>gta@;2yymL|NGy6l}lmbFAobteTm9 z>Dx~e%w{Z64DEUpVD#YGqXZp|nrV)NVHjq@&(>lhZ5S(B$=SdE-gV%Tf#q9Pgh*NC zOSVKKGwne8Dth_g?l_qY6Pp3|xzz$nyj_?S-`h=$w!$I5T84rQ}OzITN##OSoeeSaUvS3e&onDVBb zQQfgBx#-f)h1R+o#XF{v&*rhc8BZ+N>G~f#OI!Dh2dV59+7>)QtP*x^eX#x}s|st( zJpbOE)4+mBM~Y)8d7DG1S}T^XOGE^STg@U1yGj?KZi;S58bBpF=+@0^ES-n)U##&n zC*9B0#vr@kv7V02>yRl9ce}^ZE|`zoxbgRE<)+^!aAK(b{6ys1u+4{2;JuY6x@ z%5m}2cDyY>x#Tf>nOkQct6!v>uW$Ux@Jo3f^I}ka5&fFEye;lHd;|W~CANyNqwcZX zBY4W-(D5kFZkB8{FSsG7w1`(u{koWWTMPpQ$L?#2p)4s+Zlo*?u%tpUYWz#GQx=E_ zoD4Z~dJ2O<-(8HG@TI*R^&JAE0K<15aL$@~aJ27#zcKRZgYNgxpX@%BdJ8INmU{BO zGPRE=?su52YnPhLnEPnHek?}a!Tq5nCfMnyvvfp~d}x>p6ZSUKxgddFT4l7*zO+Yn7MaoH{ZxR{qg#V{gN)o9fK-Ms696`@Xx^*li!Y z)o#vZRdFao+g9oawVd6*`P^4u73WzJK&7&gRx|W2Yedi!murA7p-lY{niY<3<~1#X z{A+zZvrnFaXfR2`n3$fl3}vZc|>k1CVDdob5z9eFV0q-F)<)+YrY z`m@Wm?EXZ)KZqe6Pcw|N>8HWjRhC_-otLUuqe|%PP#H!VCte{ka?x$9iBhCIxk9Zq z?K%nH+0ENTA1!!@Z&n&?8qXWV$2Xx6`gE0LHkiZ{*A%>$!D2LsBQv4iCZr{0|$ zvSy)oLo8xKWjO9oY}@Pho5>?}+|Q^~O8L0w7g=Pl%0QA02jlQFg|M%?0%H~V0*9Z= zr6?BLG}aHbAlD?Im>Ac}JNvS)8od8O|aY1-FxHYLG6CkK$*-}PoZ>w zW{&<)Ui>YR4S$N%zpDWfzveO9%KFc|_*0?^#bbLt_G$^!F1OYl z9bh6XykZokiXRdb%5GSI6((cmh1wHN4phgbETJk6k5kqNjpLXJZeD?kx1!-=ywlq> z=U{AyX99(xujT7G=u#KMeIW7Ek=?yZ3BYr)g1vuK$q_IYZI z3=-{k5O>a#=84>~;l;;ShGmlzr)Qi}@o1T5$h(itlifMa`#T6sSFN$r#xihKV`k=6 zJX?(S9|<~p3ro1?R4O|r+Uk$7f$q-HZ&-3Ju;z`<2Ss@shF^+qp%Wd zRkzgZXa!aJ(|_!?pS(HEeXc9f*7C2?nhLBAWX2zv!LbQw&4_uXSUX*`&H2{c@X0}= z0Ml8vZOE!U<;;(dGA+fl+W zow9gSl2c3vE_cC#W!-PN@9omXxPdZ!bSFcfQj6~fclc^?L!g9aBm-gU zDmHyvtfg6Gqe|YJMco((?j`!06uI%0Y ztjQQp5#mD|qNdsTv9k<8&8qYb@8;|^@w7^Qt(2w_n8$+3vo)khFBJ{cZoaU)m)OVV z{>{zt=3b&ACdp%)$*%)6@|h;XujB104<*8-g;XZNR9cJD+zk(Js=)gQfqfE2$63A) z^26t4sr{SW9P5WKh#9DkYg|g5mt_@Mk9|>liA60jrt<0cX82yyjiFB?pK9(C-{AWt z$$rLUp>pyW8q|7`Fb}*e|Oz% zGA~7GJdN==VKuZkzi@8nUHeh-YE-`!S(CTa)Axn9v`;A+)~Dp{=WtCv z>Q?dSb2r<;!WAn5e~|q4AD%hE?3&M@v)5(Bc$U7|8d%?Q6~XPOC~t%p4P>BRs;%vO1Z2 zezp3#6iqF&={o6mRSpw+d(*WoyuxQstH*`8CD&}yfR57c`c`gmv69>o>9*;UfL@_&CT@I#q7y=lQZ;HyRl>@8O@^ddGo+p4D7T zpW%yked#CaoRsAL-RTTf!u=lhQ$<1_X;YkES17roG$Y4>&_mjAx%MAGj_8?1H_bOw zuloePm<2j;N@O%h?k*sP;$;Jbx~^AfjReILG_8!-KMa4a9LiVA*9)vxqso0B&e}qU z<1=t>V*-1q1Mma~(2OolfQY+sgJl17s)VE4$ z&%+i_^JybEi3w|DcmD@r&lKA?9fR+D@2+a3eiF3bFh?`?d}n1fin!xdH7ua;akv>< z)mh0S_SJ%Qs}Rh|rl-Mom;oqbexmKRv>eTknQ)qpgs182PEp_WrXLTf^KkFj>dylo z&fe9&UfT|>YO~7flw}C&lfG3+c5tAp_C_J4An%BS&i=K}`b7m~{hJn}*r{1Y8E%8O zB0D`)SDdT8#>R`l{wK{$`Vy_-LqG>{Mtj^w9o7Xs_ff(yrG>` zXc~wz5HTT6==$3%&Zbf^*2E`&&yPE&7cz*nM9k2IklsaSx_q?NH=e22y}?o2<0=}o z(vAsoB}qNDy=U=r$(bPdR3$&()4CrXfpNDSkj6FMub6Wk8a+_3kKWD3?Tqt_xPnWf z2Mo3F)wu=#0=^p?uSTp@fKG`c`Elx2$1#t#=|XmBIt#XGbcgIdtke%=m$}`-|MWN# zsA+Inz|Jb(g65m(R2w*r07OMjJHOrYWJ*;~T!IIU%EU z>9gDCB=+MkpI;uM{fUSqu8r0|v5a*TxmX`TePT zyPoKO7Ki$#_q-bDHE>kWcYd#)wCa`pRnD49!uq3kFpiB^0u{ZJDlv1iPhcl*v$oX-u;z@h`Jqg7wgriD|bGkFO0QGjVibK)$pd2UJmaI zCXXpc*XADBKA6H_re+HSD|J`0E|nieNCe}dU3j!FzeUuF+{{hFq4vSuefq9!K3vdQ z_$Fm6hlP;-Ppws6>hk>v^cz!bzBQhX7h8?bLn?7Ota>Z0us<+Doj?ZCzIk2J7{qp4CU=c?=W8bGx zPEyPNQb+&N%}-9YfaZNgIjv55Y}%ivHJ6RFb5T|Bs)91WCgF ze{JHz|DRZ~|6&o65c^jw3Tfrw3`73XkQ8=Z1Of#*{c`b3 YFLy^-AyL1W5f>4M0692RpsK+C1EH5r_5c6? literal 0 HcmV?d00001 diff --git a/docs/schematics/other/uart-programmer-wiring.md b/docs/schematics/other/uart-programmer-wiring.md new file mode 100644 index 0000000..4457aef --- /dev/null +++ b/docs/schematics/other/uart-programmer-wiring.md @@ -0,0 +1,5 @@ + + +

This browser does not support PDFs. Please download the PDF to view it: Download PDF.

+ + \ No newline at end of file diff --git a/docs/tutorials/firmware-update/beta-unit-firmware-update.md b/docs/tutorials/firmware-update/beta-unit-firmware-update.md new file mode 100644 index 0000000..03d602c --- /dev/null +++ b/docs/tutorials/firmware-update/beta-unit-firmware-update.md @@ -0,0 +1,65 @@ +# Pyr0-piezo Beta Unit Firmware Update + +The firmware for this project can be updated using one of three methods, VS Code, Arduino IDE, or avrdude. + +Please be sure you've already [wired up your sensor's UART port](../../schematics/other/uart-programmer-wiring.md) + +## VS Code (Preferred Application) + +### Installing dependencies + +1. Install [VS Code from Micosoft's official page](https://code.visualstudio.com/download) +2. Use the "Extensions" menu to install PlatformIO. +3. (Optional) Install extra plugins to assist in development: + - GitLense + - markdownlint + - Markdown Preview Enhanced + - C/C++ + - C++ Intellisense + +### Configuration + +1. In PIO Home, open the firmware folder: + - `~/pyr0piezo/firmware/AVR-Source/Pyr0_Piezo_sensor_v2.x.x` +2. Make certain you're on the latest `develop` branch + - In GitLense, under the "Repositories" menu, expand the "Branches" menu + - Right click on `develop` and select "Switch to Branch" + - Back at the top of the "Repositories" menu, hover the mouse over `Pyr0_Piezo_Sensor_v2.x.x` and click first on `fetch`, then on `pull` + +### Upload + +1. Make any desired adjustments to default values in `src/pP_config.h` +2. Click the "PlatformIO: Upload" button found in the bottom bar of the VS Code window +3. Verify Serial connection by opening the Serial Monitor and typing `CONFIG` or `STATE`. You should get a response. + +## Arduino IDE + +1. Install [Arduino IDE from Arduino's official page](https://www.arduino.cc/en/main/software) +2. Under File > Preferences > Additional Board Manager URL's, Add: + - `https://mcudude.github.io/MiniCore/package_MCUdude_MiniCore_index.json` + +## avrdude + +#### Windows + +1. Install a bash-like terminal. Choose from a number of options: + - [Windows Subsystem for Linux] + - [CygWin] + - [Mingw64] + - [Git Bash (Comes bundled with git)] +2. Download the [avrdude binaries] +3. Extract the binaries somewhere your terminal can find them + +#### Linux + +##### Ubuntu/Debian Distro's + +```bash +sudo apt update && sudo apt install -y avrdude +``` + +##### Fedora/RHEL/CentOS Distros + +```bash +sudo yum install -y avrdude +``` diff --git a/mkdocs.yml b/mkdocs.yml index d89db93..7cc29ad 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,6 +59,9 @@ nav: - Makerbot Original Under Bed: 'mounts/quadrap/makerbot-under-bed.md' - Ultimaker Under Bed: 'mounts/quadrap/um-under-bed.md' - Configuration: + - Update Sensor: + - Sensor UART Wiring: 'schematics/other/uart-programmer-wiring.md' + - Beta v2.x.x: 'tutorials/firmware-update/beta-unit-firmware-update.md' - Pyr0-Piezo Config: 'config.md' - Settings Explaination: 'tutorials/config/pyr0piezo-parameters/pyr0piezo-parameters.md' - Printer Firmware Config: