From 639dbe8734879b1c2bd2ea353ab3089d722f8968 Mon Sep 17 00:00:00 2001 From: Peter Hinch Date: Fri, 3 Apr 2020 06:34:51 +0100 Subject: [PATCH] Docs: provide basic usage examples. --- README.md | 7 +++++++ TRANSMITTER.md | 16 ++++++++++++++++ images/circuits.fzz | Bin 5098 -> 6714 bytes 3 files changed, 23 insertions(+) diff --git a/README.md b/README.md index 2eb3a47..750a131 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,13 @@ firmware builds. The receiver is cross platform and has been tested on Pyboard, ESP8266 and ESP32. +In a typical use case the receiver is employed at the REPL to sniff the address +and data values associated with buttons on a remote control. The transmitter is +then used in an application to send those codes, emulating the remote control. + +Other use cases involve running the receiver in an application. This enables an +IR remote to control a device such as a robot. + #### [Receiver docs](./RECEIVER.md) The transmitter driver is compatible with Pyboard (1.x and D series) and ESP32. diff --git a/TRANSMITTER.md b/TRANSMITTER.md index 2cf169a..3e3290e 100644 --- a/TRANSMITTER.md +++ b/TRANSMITTER.md @@ -85,6 +85,22 @@ It implements a class for each supported protocol, namely `NEC`, `SONY_12`, common abstract base class in `__init__.py`. The application instantiates the appropriate class and calls the `transmit` method to send data. +Basic usage on a Pyboard: +```python +from machine import Pin +from ir_tx.nec import NEC +nec = NEC(Pin('X1')) +nec.transmit(1, 2) # address == 1, data == 2 +``` +Basic usage on ESP32: +```python +from machine import Pin +from ir_tx.nec import NEC +pins = (Pin(23, Pin.OUT, value = 0), Pin(21, Pin.OUT, value = 0)) +nec = NEC(pins) +nec.transmit(1, 2) # address == 1, data == 2 +``` + #### Common to all classes Constructor args: diff --git a/images/circuits.fzz b/images/circuits.fzz index 7ecee24c990016c6821d293cd215f0fc1567bb81..ea36cc8916696408266c8147c8c3b86d0e16be60 100644 GIT binary patch literal 6714 zcmZ{JRa6uV(DqVFcXzXNh%^Ye^wOoYq)Q7@OLr`}bk{0~(n@!CBMrjRDX}#A`+on; zck|7hGtZp4n7NplGv~~sqk(}*4gdhK0fy0mI^)p@>K+;Z0N#fN!21`qfq2+>K|Xp4 z*h5duSKuoW@W8WbtM}H@_N+$4rtAb7GAqQAs>NETu$G5C{(@tp5eq!ej+M!t{BsWxBan+4owpSZUVja^4s(|? ziRZdp*=zqBaHDT|{pWtoc+wtr9u1*h<>NXMyq{(oref9!F~d+r(+f#JSlfj4$IP%O z#6%t2i|X0LO41X#{o23Jd57aCm=!;k+5Pm`aI)p!S+;hLcHmc+6}x`y zm?2VW$qI^qcK6!0b@;ERhImZ$zyFDM+B1BzcJG&jriIc77Oh#MLpw(EFC zKCo!x``5Ar?N$=`s}mdiVrQCUulT9zsWv~J7j?p~oI9W9_XY9@7E*Pk$2XFyV6>dm zPL1z|wA>`AgWd>!96$P7971G2^No^K$1#cHo^e z@!$4`0JlLGU2BI{tZAb8%M5;+^bP{5diVB6`T${Al0pm${ehgnV$vT5z0B`+C6nYh z&e5h#ipw}ai-UHRGS)QV@pR%fMCPeTugD&RDlE*r1}vSkEJEzu?4LbYNvK};OrM-v zzo>f>ciWJ^IKspH(CHpNWE+lee~J24c)2Od_$ZPce0v3LZZaoy_}Z;~?MutPXRuMA zt*?(C@b^eVt8r4#-${B7}81 zIdb%%Z|AXzkb8ak{?7@@?Fps08RRRwY&niD)|j&}x*72D?E%?|UQGdg-(Iq-(9&h3?8b?*DdePbWHy|T8bzV3 zX$3UT#N+<{{X_JSY10ta6q;XMd^6bb@m2QouMeB5KHiu7xbK8=!FXUiH9-Rnn_+RQbAZ zw+lFs@`LzyJcrliQ)%?epSOZraW!9nDsm;%FszWhyW1;k-Js8yMRoC9zCzw|yKb}5MjM&3D#!JhriWU{1;vu=~r z1&gnA66|eyh#VeOr6mt3e{Q5hJJ`D$_h`Z&>@K8;yj-%xW#?D}o7Tan0rAJ(KxXol zz!G5`*eWcgoRkZ}VOuq%RB)bp?uu^OIn$7u%eBJ>P*Td5;m6RE=htY{L|04lMKtF$-6_K(LqpT1){flt zRVzIyajjkkiU>e2NO4ZFL)5~O4krZ>>4`28=`mOn1?U5NYpb{M9W6V}R$4|aY<^cY zNV|=JeY_g2`usVOlyzgU|D$Z%n!0Ot_yDeD@SHWFbl~&ZMaj1cygmw*#&N5&zdv48 zt zKsd|WIh@*KRh`w9cZK*4H7_-O-Z$~I$C4SU?{h`ud9bQ*3D$AB-K$1jgA$W==ThPk zvI)pn6$QNsF2#*%KRWqbsm`u&%$icSQ}Vwb{4!XuowyJgqc;CopS{kHUYhe43GB4X zWGanh95%T3Vtp0$zW4yh<=`dWwsHDUU3TPV%;XlXU4IaOdOQjadh@Nb-L(3wlLnuW zk+BN{4YqRva3ZlUg7r_5K}{bC(LtP^4}IVbSby2JE&u}y19Uu_15$PVQH# z|3(!3(eT+5%Zhg?9tZciHSUyz**jicBo%U-W~S8Ni}x>_)miVK32c|(D|?0PLRlgH6T+om-j{Mvr_VfhzZRicgvL%!sfw4b z^?Y^GuZ^1A1=Qeo-4?jQS!Z4w2zIUD43{Iafp2)#I_w+XRyR|zjW|w#0aE!UF5shj!!^8 z9OgUkRn7;_D@o`!c-x%?0(~@OKZv)LC*KtF8Mb?-E;JD9x8iY7QUf6zG;wW2c8Nrv zl-wiY$?W2P=^(|o%NJwZ4RVAvR(?hSwtY3mQF3YKH^l~9bpb%gGfPMJVuZ`E&0MR_ zY1)NA+Ir-LJ8C^rWQbzmeY-#!=4b*Q$4sz4(@3Bi81YSAm=qU{*ysX1ABbZF=)E=e zAS6btN7mIeSGDL=*l39+d8&-|5vs3Ft4g1~2eoV~Li~|2c%M*vps`yWPOz-Jq~~~~ z-WP8(ppz~&k1xMDQ~^;v)}m- zy){+cs$n?|1mtLWX;=E%}#2FZEpb1qXG*{uoTjgHL%<%;X11#Lg{4DaJ1_S>7oL3}YzGnO^-K&FyNwd6CUZ@nWk9!Nj?4dfnHB5J z!%n7Fb?^1qV2tm2OOha%2EL?$iF0XNBQB&QYN^rtB;IXnAdo!Cf!bB3Vo9c|Mb>#m z3JBE39~wRhhC(lD7fp*Dw%n_Aq6nPBF(bt+E2cc-YcFn_*A6+%qPeeRa0vv8pwaTE%30dV z=^q^GB&gm0Z-9swVm0`nTcof82T~H2zS6n3JCjJRv68`r`WO5MG!C|UlO;EN_bN5} z!UsHMpC~DxATp$E|~hR?i|S-a0Xu7@3)F7GU{O)Y9JY+auh`6Zo&mggBU_h*khkZ2mPYLtxNGRJe4 zqT)&kMq)eZ$$k2I^g-j?M6f^b{av2%MBsC;J;l5hFI1SfKpzE`0i{>DSKc*=?^9$` zCvj&v-iNKBNQn=4>2G%x&1jGkWAjXOuk8`fcOR$(gM})N8Og<|eQ%&mIq_AlJ*fGo z(AKjC)|BE!NP#LEIaqH}4WAHG#=TcD1~Wvx-}O&??jK58Hn9z#(J69cOX|Mut3&B` z3~BOiuXoD$4J+`B*WXO0llD!TR?Kbs!QvLrUjfn{lwgf(rz!oAiTFQ(bu#ad;#vdS z^e0S9PiiB-&+rmXI>q`!(YCx2Z0JPM{I7IM06tT=3=|bReCuJon|?zRDt9ja1(jA0 zofd>dbb+Pz6SX8cH>EK?=tiq%6pP;|M{X60$RupJ^oNSvCzOu z!g2nlc;=VG>l!rI9u>c}dA!-kkg!$K&$F`E(3^jow|=r$i7YU`}%}qpcU|LnR z-RCTwuIX43x!jhOc4Q2t%F}`0dUeR)xYTChT>FuFYsjAKJm|6%aupk(CNwQp)Z>&= zX)oEaagz}l=L#VgexxEl!F0w9EUCcmbuZ>BlD3N?vih1vFWsV;-w;v(4o!3yq1w3} zgj%u-j_qoh+9LN(b7O(Oe-m`Foxmef*upah^BbUk+mzp3LAzs(tk3z4XSqrtm)5jN zP&)14C>=*DoGUadH>UDT9AoBKz7SYkBq_esJs3WrzobaQ(8HDV^i^@8R@ll$L zO7li2?*WGJDT!go%xad;-ka8*D)R~-&*P`HJxn1*#AJ?6l969-j$sFSE zl+5TApD{prX1}wNCIW7d`N2oL4|q7go^48 ztoMsm5*R-zzj8AVNlmFe6H2eLMhU+dMb_Sn0~5n{1$5Y6*b1RqA^@-2h|B#NLvp@T z|KhUHG*>z>>3PWG9K{t^d|V7_LZ3}@IVHvZL8&zyy8Zpvqa$6}T`m1L#xhwg|2%J; zvQZm0AI#FV5z6d07n*G@x%)hI{#M&O%Hjng7bmgTgk2(L?S$weJeam~{PM2TUFX+o zug@W@^=uH%E!BscPy4_;z8`1^`bMu4^TM@uQCdjIgOve{JP+Mn+ zxkO`>nR(6fs2WhifSEKAf5x&ev3Dy*(Z978O0#$~v*C3rnjPr*D-=zDyZBw27I!H2 zr?hW`B)Bo=G#EL-{A{2vBx8vPC+b?1=0{=w*FDmwtq$z zX6(mH<}$bJm9sNmd2B}R#%J+{lf?0RB7(j>m^i^fFW_K$vGfCnXwbp5#KVX}m;DQm z{HOs}yPcBv;R7bTKiu(getipBnwO$~K{UviC`<1{lUU1U+`Y&TY*5X!Wj$o$L{mxR ztfDA^&I+Db~b>guA;^Uk)(eHZF9c7Vsh;Hc{`HyzIhp7D|L(>Tb_}o!|DB%d z-~7sC`RLC4d?ofn!{NwA3MfY&UB^1%K0fD>VZM~|2I|^w@$DSJ9t~5b$(twOdvn%_cU)Gq|FE?%eJqOYc72%2q4!ZyU8rTCn zLihJ&_`g8X2Xq);Af0IpRtTpOY#8D=m#DFb=RKuZ!D#B}E;(@*Gl-ho_ul*xJ_hCX z!$0uU7>Hat^x;xQ5L`P|g2cTfXAzD#TdEAwou^ts!=acG6JZKwXH6_!sJ0Ui^9X2O za6-pt&cMpCcX8KvI#}h0OX)%>`Fq8XV)mHhi0U$}TwIUNJ&W!8a{0h}hkzVw7I>c| zIr>N%^1f^`H`THN@9;k~tw8#D)+|rvmNKS`si?|3FVpvFYOZPL&X)6ezdJY(a%Gie z2&+`JkqC6NaWhGyEW|`mWg&+iMT^B0s+qC$J``@3*EFld#_1M+rta6uMY|sEo3E}G zI8u(qF2waLn^S^a>88{lf1w1AA29lRv3EkN6EXb`W0bn@XM8_jktj-kP69>d;DG1e zl5Ad#-wa+p4cpHekcRkN%$I}9^V!j?q?J9ul@`zX#abD9@TW>Z%<~aVxPE|?@$v&@ zk#S9{hPWkBI*b0n#|yd-v8^5XbWCw$jHZzs26Zc?^`~I zltxZcC_oP6+09)r%59sYsQ4ThW>H&o^CDVR*Aft&L;D1C1#?~dnfvrkv2>u?Ax`-CsVJRg8tMfc!}Jz=x6Ez*ZUaHB*6(E`S5?pJ{d0(}f6$BYkRAy(b67GuKK|_1 zGHRb6%N*u`N3UlS(nohS6>aGH#y86<3R5r3?vQLk0-IKDbBsm@sm7H@QW+LK`O@|@#_F;31j zI`3hxS>q9`7khlv9#H)m_j6@f9yLeOo`q^0!t5Kpqqz?8=??{mkVWvo7j^Y?Z&0Ln zTaO?7(@jtBK*49Pky&@#OX!D@ulfH|7Ep1qtdkxEN{?!DHKnN#-~#WJUae%Hjq)}{ zTPB5kg|`@|8}$uW`VzFTg3aZ)?#1$=M~C+hm0^(C--kgWoh`Ex)B@F06k$5ZzWKF7 zTy)`F^K8Uh53x~Gl-SJA{DQ%5cbVL=vtBO=!2RGV*tIdVA%4XFg=pvLr4>RE+il== z)BwIm#5sxpE^dGe)s*}s^E00Jsv5H%=_*Ws(aW$1H_;^coAcPiwtgKY+H$x1_vt1W zD>$+BCKG+*F1R{<%wWPv&Q30!GbD|GeReNO)N4>kepGSE@BK@noI7mDnH-A+rN^#~gsG;tYY}_{ZdQZqO?z*9N~(e3W#Q_p@#1SB}6{#&4Kqg=xAU)`!9y} OPbL51(LaU=0Qi3e9{+a$ literal 5098 zcmVBRdQ#`AGByX+tUJ6<>&M8olHblLfzt6#gk z^VgrgyO>79he_z&#^dChy!B`L00aV%8vrRl0{8v+jHnS_@ed-Gw^k3D(c>w2HU`S@G^W)jMm&gSywK#Iv*sN+43hsoV# zhXcwO3kK7UcNdOFcgbbP2aL*({HkZG*UQ%L;_Enk%+^(1d$ayj7JU-Y6aqKaanKsu9t6*74?d(c^phrR;`|*Po0>v#V%v ztzPkK98KSZlju=ClGg0y`{#qZaN1ACgJxcTKe#D+G0~sZ7ejydH+%huB$6d3;h*FF zCpj3e?#6>Jvv5AY>~y?$pWa^oJq+*VeRa8zy^8yT@Smo~G3|KoKfceElV$!bnuMl; z%kIzg_(eL7vLhhlN@mYlhfk9ud4S$FAnF?LoDCWyYI)z zyf=vAP=09(xt5K5ojgX@6IJ#c+VmnW}h z#zLG^z_OnJZF}C#qeTHe19as>)(X(`_a`+kFM8(h)%!1I+!7^LrkkgK=w(O2OJ`kL zKQRiUX_&;%-ZwP>eF!1%cu#s@J--;(i)VVPugQ_H<36o`7A;c)q-ubOu7Pi=Ao8nV z-;i@_Wy+^DDF5^E_MgA(5|YL};8x=wZN`ZQ5u;OF1pF}l2$nOn>L#d*`ojL2nm zD;cEAZUvaP8QqQr38aVQ^HA<@|Q{^R2x-6RsY8{Q0F zj^+T?H=2{UKbw!|az(qI%f+-mxt2A#zWRs2*T1}ZTRg!3yW(+OrjxK9&A#p<&IMq; z?kFD!%&?!=UAhPf@H4p{MsZHP)`h&qUrLi)T*#qXw$AHym-Uq@FM*ut3KOYCLA18A zu01~qN1G+I)O|FbC0mB=+Cw+tw{aMkk$h1+2O=nL>)qdR(cAbdFM5j}IH2>;p`8Z- zkweUN-b<-tbRImk^8le5*d9#P-2xgyIbAob~zv3++5FGCVd!dTUQVfg>w|N8&2%~xPvu<{uCvhAV!@ywgw z_Xo1Fi>D}r-gG=Ea4mdlOt&?VhJyewvtUtam-wP)-S$xRh%g{A!TBgu4`O3vMV+N$}rZRLcrEMsf*{gF4kD$e_#s2s-PVG zh++`DR{hAhjVR6NM}kPj1r}NwTbo=K76g!``cWWDOVuO!LX>HE2r%SC`GuElk7%pa zqul2*i~CNmiyqskhxyZ~Zu}3wyem}2SbeIPd~J6W&cb*+=*p^;(8va=whIO6x7lsn zkHew&pMt{K^uG!;CHb1hbR{$Ch)<<`kL^5>n1qAeO%Yv4E3_q~w#bliN2uA%Pi@VG zsVhYS)Y|sm{x3NRbxAn^IB}h~CUxoxlR*<71BiS-HNAWm?C((`KyYe`B19LJ=T$;L zXjAVMs!i6~)k-R*7Qq7~5xj6@8^afwLCnwvC2b+GO4jsCU;;A=9NKch1!a5Fjiio+! zNR_1i!1fD!gUB0laUf7N`IKPovr!HkGN?Ruz!~3{w?RYWZBSjEYFI z+BpG?s+iA=XAJ>}eSUgs;(58(KB{Vc=--5sB3+T=Eiuyimt9X(86|YSuhAswkCv+2 z+Dc=!uRkmChwVOvv6;dGTEz=W!!pQS4tIy|y=y~KOH5jIw5T@qqZ_wPBWEr_cHVPM znvkKmDjC?55&RAG8j%-m1;ZRQFBM8-3F zN7Jm{L{I5G4|)Q6h}hePDwjSd(#O6Z$^ZX?;E$fF&d3`Nt<0h)Udm}f)ivJjcrvll zHK$D<*zTkZ{=De$=5BM`vkg=QZu~PJ;+5p|jwCrhFF7t#FK%7ptye z(G%z^kGI(uVCv8PBM&5^E(k61PmGlb>i8_?X036Q;w<7Qn^Hhg;NmD(rCxa`o)&U( zl%WmuNwloAF z!%KRui=#aCI7$(mR~#i>gO>`zC}~q+lrD;LMao4{x+u!c#k(j>s0A+sLVkm`ZCWf*Sb77BB!rBx=$yyXcnI;I3E20R@ zzKqa8zu1LPmI$Hb5V{ab7eeVmD9<>AlC>v*@(k9}=cAJL-!EtV~%NF1?svD<& z|M(fp&(Ax;w2Cr22V~}j$jluwQ&!>JeW%i^vx$2zh^nGQ|J*^6naA=pn+r17h1ckM-g##643#E zyw#(KfFRsa=+A{h&k;W}=T$975wWH?^vIFuSEQW#%DJyL7w_CxUY<6F(M$K$fkzQ# z{8xlJ|5Z^;P39;fOq9=wogsuC0mDk zkbr5cSoE|_Ec#&mBqHJ~PI9i9+2EMP+sMB)vFIx?81@(?L7Q0gL5o=Qc*XBMti2iGuYO0{)V!>p8x)pD^~n~Qg`T3)VZL@T8lVjL_(wV(^t zTGNh#HL9WT0V2g@j-9B69GS8l)iCdM?F@!0z1N}?+2ibsyX5k2U%b+NahF^^=aaMD zf!ebtj@q^JLRR*~1qGBBRj6^Cb~$+6p19i+KY=~*o$`M-pL@4mh|JdZ!i92-!(8LB zHdID(rTY2JySHj<{sj!zn0EK3KOYaSZ^PvJe#5r+j%0$vO-uq7!E9JCWn$WV$U^zg z(GKCqJ4YWw8+=Td@xs^50+M4b@Oes?pa2uIClI7fu(WWYG*8s7M8@cq4{#M*(qhYZ zt3j%TDvnp!Hrf_NW*vhi9d~IpHq`W`Xt5`Ab*eME{tK?+{$~Gxeo=3Gr4DxCZ9qOP zP{p2rp84rHA3Oj8rUy=P3^t@WX-B{dW&n!722?Rs-$D=M;`w%Ymre17sf%_mev4mO ziyUP_EqnBz78J`YTZjZ8*xWWH zVsipumJw_=p2$mekO;t9xb>ukDqf2>_rrRBv`v+>^-o%($mQDA^%$>|Hf_A_$SSVS zctt+Z(O>6eysGVAmMZ8B=zW>T8pbPf#;do%c%@Ltxnc7z z0;Y1tIn(uZ>7!c6nSbSqKUJ5*CKzn1%fXqhZG(!In66j=n|B86&nsamJEiLb_FAo1 zbW+yqCJ;M+>$Sug3AD!Js*ZO?!jAOisuG`JdulsU3AXJ{Ct?8apVXYF#PQ3rC=euY z>9voUURw)PM*u1oU!b3Cy3J|B34Mc!Ak3%%- zY_!G>Q4EP3yyE8<5DGr=Rh5=H{m?x%^Z@j zW6qPR)GvEtDDnZc)cG!!Rt04ROq~7J)IHL@`->9_boQe*oZ#Rec!EQ{1J~b{HMpje z5}L6a(u38Mzcnxsj$KB8PY6Hx0|B%^WfRHFa7-W|+#Xl%OXId^f*)ZXSf&@iAlRRKa=2EIw6& zvsmnM5^B9c$p7&#~|=fC*uKzMJ}*atlITQCNgAMBoRR|_~0 zJ_Ljn2euG*x9$2p%7^oyR#&Ijp8A-fu8OYKU#Ho3CAya_laDNdCe%4_PiBMt+5Gc_ z4Lg%lLPLFY!n59Z4}cJYcRcm$ex3A3a}~E#oVY-V{qmH={kaNqo~t7_0<6NR1~!U` zLiJzAi&R*2@~ne}Z~C&4hZ`c$YD=fFsS(#3vlTo{nv+wbjXd%bYGa(2U$>Dqt~+Ik zPC8HmGiWyFCZ@p0Y?*Esah{7FNZK-3bM-881o{m1eUSrWfLEad@!?Q33>~G~a=lI4 z1|6Ab=N4ke2{rO2>^O2G*Az8vX#Uy>?R*Q+t9HKC7eD0OZ_fSJsQV4`G^dAL>ZBVVc zU*mEU007fP0RRgC00000000310000000000V`*|@b!l{SE@paAO9ci1000010096w M0001+6951J05F-;;{X5v -- 2.47.3