├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── doc
├── arduino_one_pin.png
├── arduino_one_pin.sr
├── arduino_two_pins.sr
├── eps_two_pins.sr
├── esp_circuit_onepin.png
├── esp_circuit_onepin_voltage_divider.png
├── esp_circuit_twopins.png
└── esp_two_pins.png
├── driver
├── Makefile
├── easygpio
│ ├── .gitignore
│ ├── LICENSE
│ ├── Makefile
│ ├── README.md
│ ├── easygpio.c
│ ├── examples
│ │ ├── dependencies
│ │ │ ├── easygpio
│ │ │ │ └── .keep
│ │ │ └── stdout
│ │ │ │ ├── .gitignore
│ │ │ │ ├── README.md
│ │ │ │ ├── include
│ │ │ │ └── stdout
│ │ │ │ │ ├── stdout.h
│ │ │ │ │ └── uart_hw.h
│ │ │ │ └── stdout.c
│ │ ├── readgpio
│ │ │ ├── Makefile
│ │ │ ├── include
│ │ │ │ └── user_config.h
│ │ │ ├── localinclude
│ │ │ │ └── .keep
│ │ │ └── user
│ │ │ │ └── user_main.c
│ │ └── writegpio
│ │ │ ├── Makefile
│ │ │ ├── include
│ │ │ └── user_config.h
│ │ │ ├── localinclude
│ │ │ └── .keep
│ │ │ └── user
│ │ │ └── user_main.c
│ └── include
│ │ └── easygpio
│ │ └── easygpio.h
├── ping
│ ├── Makefile
│ ├── include
│ │ └── ping
│ │ │ └── ping.h
│ └── ping.c
└── stdout
│ ├── .gitignore
│ ├── README.md
│ ├── include
│ └── stdout
│ │ ├── stdout.h
│ │ └── uart_hw.h
│ └── stdout.c
├── include
└── user_config.h
└── user
└── user_main.c
/.gitignore:
--------------------------------------------------------------------------------
1 | # Object files
2 | *.o
3 | *.ko
4 | *.obj
5 | *.elf
6 |
7 | # Precompiled Headers
8 | *.gch
9 | *.pch
10 |
11 | # Libraries
12 | *.lib
13 | *.a
14 | *.la
15 | *.lo
16 |
17 | # Shared objects (inc. Windows DLLs)
18 | *.dll
19 | *.so
20 | *.so.*
21 | *.dylib
22 |
23 | # Executables
24 | *.exe
25 | *.out
26 | *.app
27 | *.i*86
28 | *.x86_64
29 | *.hex
30 |
31 | .settings
32 | .cproject
33 | .project
34 | build/
35 | firmware/
36 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
676 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | # Changelog
2 | # Changed the variables to include the header file directory
3 | # Added global var for the XTENSA tool root
4 | #
5 | # This make file still needs some work.
6 | #
7 | #
8 | # Output directors to store intermediate compiled files
9 | # relative to the project directory
10 | BUILD_BASE = build
11 | FW_BASE = firmware
12 | ESPTOOL = esptool.py
13 |
14 |
15 | # name for the target project
16 | TARGET = app
17 |
18 | # linker script used for the above linkier step
19 | LD_SCRIPT = eagle.app.v6.ld
20 |
21 | # we create two different files for uploading into the flash
22 | # these are the names and options to generate them
23 | FW_1 = 0x00000
24 | FW_2 = 0x40000
25 |
26 | FLAVOR ?= release
27 |
28 |
29 | #############################################################
30 | # Select compile
31 | #
32 | ifeq ($(OS),Windows_NT)
33 | # WIN32
34 | # We are under windows.
35 | ifeq ($(XTENSA_CORE),lx106)
36 | # It is xcc
37 | AR = xt-ar
38 | CC = xt-xcc
39 | LD = xt-xcc
40 | NM = xt-nm
41 | CPP = xt-cpp
42 | OBJCOPY = xt-objcopy
43 | #MAKE = xt-make
44 | CCFLAGS += -Os --rename-section .text=.irom0.text --rename-section .literal=.irom0.literal
45 | else
46 | # It is gcc, may be cygwin
47 | # Can we use -fdata-sections?
48 | CCFLAGS += -Os -ffunction-sections -fno-jump-tables
49 | AR = xtensa-lx106-elf-ar
50 | CC = xtensa-lx106-elf-gcc
51 | LD = xtensa-lx106-elf-gcc
52 | NM = xtensa-lx106-elf-nm
53 | CPP = xtensa-lx106-elf-cpp
54 | OBJCOPY = xtensa-lx106-elf-objcopy
55 | endif
56 | ESPPORT ?= com1
57 | SDK_BASE ?= c:/Espressif/ESP8266_SDK
58 | ifeq ($(PROCESSOR_ARCHITECTURE),AMD64)
59 | # ->AMD64
60 | endif
61 | ifeq ($(PROCESSOR_ARCHITECTURE),x86)
62 | # ->IA32
63 | endif
64 | else
65 | # We are under other system, may be Linux. Assume using gcc.
66 | # Can we use -fdata-sections?
67 | ESPPORT ?= /dev/ttyUSB0
68 | SDK_BASE ?= /opt/local/esp-open-sdk/sdk
69 |
70 | CCFLAGS += -Os -ffunction-sections -fno-jump-tables
71 | AR = xtensa-lx106-elf-ar
72 | CC = xtensa-lx106-elf-gcc
73 | LD = xtensa-lx106-elf-gcc
74 | NM = xtensa-lx106-elf-nm
75 | CPP = xtensa-lx106-elf-cpp
76 | OBJCOPY = xtensa-lx106-elf-objcopy
77 | UNAME_S := $(shell uname -s)
78 |
79 | ifeq ($(UNAME_S),Linux)
80 | # LINUX
81 | endif
82 | ifeq ($(UNAME_S),Darwin)
83 | # OSX
84 | endif
85 | UNAME_P := $(shell uname -p)
86 | ifeq ($(UNAME_P),x86_64)
87 | # ->AMD64
88 | endif
89 | ifneq ($(filter %86,$(UNAME_P)),)
90 | # ->IA32
91 | endif
92 | ifneq ($(filter arm%,$(UNAME_P)),)
93 | # ->ARM
94 | endif
95 | endif
96 | #############################################################
97 |
98 |
99 | # which modules (subdirectories) of the project to include in compiling
100 | MODULES = driver/stdout driver/easygpio driver/ping user
101 | EXTRA_INCDIR = include $(SDK_BASE)/../include
102 |
103 | # libraries used in this project, mainly provided by the SDK
104 | LIBS = c gcc hal phy pp net80211 lwip wpa main
105 |
106 | # compiler flags using during compilation of source files
107 | CFLAGS = -Os -Wpointer-arith -Wundef -Werror -Wl,-EL -fno-inline-functions -nostdlib -mlongcalls -mtext-section-literals -D__ets__ -DICACHE_FLASH
108 |
109 | # linker flags used to generate the main object file
110 | LDFLAGS = -nostdlib -Wl,--no-check-sections -u call_user_start -Wl,-static
111 |
112 | ifeq ($(FLAVOR),debug)
113 | CFLAGS += -O0
114 | LDFLAGS += -O0
115 | endif
116 |
117 | ifeq ($(FLAVOR),release)
118 | CFLAGS += -O2
119 | LDFLAGS += -O2
120 | endif
121 |
122 |
123 |
124 | # various paths from the SDK used in this project
125 | SDK_LIBDIR = lib
126 | SDK_LDDIR = ld
127 | SDK_INCDIR = include include/json
128 |
129 | ####
130 | #### no user configurable options below here
131 | ####
132 | FW_TOOL ?= $(ESPTOOL)
133 | SRC_DIR := $(MODULES)
134 | BUILD_DIR := $(addprefix $(BUILD_BASE)/,$(MODULES))
135 |
136 | SDK_LIBDIR := $(addprefix $(SDK_BASE)/,$(SDK_LIBDIR))
137 | SDK_INCDIR := $(addprefix -I$(SDK_BASE)/,$(SDK_INCDIR))
138 |
139 | SRC := $(foreach sdir,$(SRC_DIR),$(wildcard $(sdir)/*.c))
140 | OBJ := $(patsubst %.c,$(BUILD_BASE)/%.o,$(SRC))
141 | LIBS := $(addprefix -l,$(LIBS))
142 | APP_AR := $(addprefix $(BUILD_BASE)/,$(TARGET)_app.a)
143 | TARGET_OUT := $(addprefix $(BUILD_BASE)/,$(TARGET).out)
144 |
145 | LD_SCRIPT := $(addprefix -T$(SDK_BASE)/$(SDK_LDDIR)/,$(LD_SCRIPT))
146 |
147 | INCDIR := $(addprefix -I,$(SRC_DIR))
148 | EXTRA_INCDIR := $(addprefix -I,$(EXTRA_INCDIR))
149 | MODULE_INCDIR := $(addsuffix /include,$(INCDIR))
150 |
151 | FW_FILE_1 := $(addprefix $(FW_BASE)/,$(FW_1).bin)
152 | FW_FILE_2 := $(addprefix $(FW_BASE)/,$(FW_2).bin)
153 |
154 | V ?= $(VERBOSE)
155 | ifeq ("$(V)","1")
156 | Q :=
157 | vecho := @true
158 | else
159 | Q := @
160 | vecho := @echo
161 | endif
162 |
163 | vpath %.c $(SRC_DIR)
164 |
165 | define compile-objects
166 | $1/%.o: %.c
167 | $(vecho) "CC $$<"
168 | $(Q) $(CC) $(INCDIR) $(MODULE_INCDIR) $(EXTRA_INCDIR) $(SDK_INCDIR) $(CFLAGS) -c $$< -o $$@
169 | endef
170 |
171 | .PHONY: all checkdirs clean
172 |
173 | all: checkdirs $(TARGET_OUT) $(FW_FILE_1) $(FW_FILE_2)
174 |
175 | $(FW_FILE_1): $(TARGET_OUT)
176 | $(vecho) "FW $@"
177 | $(ESPTOOL) elf2image $< -o $(FW_BASE)/
178 |
179 | $(FW_FILE_2): $(TARGET_OUT)
180 | $(vecho) "FW $@"
181 | $(ESPTOOL) elf2image $< -o $(FW_BASE)/
182 |
183 | $(TARGET_OUT): $(APP_AR)
184 | $(vecho) "LD $@"
185 | $(Q) $(LD) -L$(SDK_LIBDIR) $(LD_SCRIPT) $(LDFLAGS) -Wl,--start-group $(LIBS) $(APP_AR) -Wl,--end-group -o $@
186 |
187 | $(APP_AR): $(OBJ)
188 | $(vecho) "AR $@"
189 | $(Q) $(AR) cru $@ $^
190 |
191 | checkdirs: $(BUILD_DIR) $(FW_BASE)
192 |
193 | $(BUILD_DIR):
194 | $(Q) mkdir -p $@
195 |
196 | firmware:
197 | $(Q) mkdir -p $@
198 |
199 | flash: $(FW_FILE_1) $(FW_FILE_2)
200 | $(ESPTOOL) -p $(ESPPORT) write_flash $(FW_1) $(FW_FILE_1) $(FW_2) $(FW_FILE_2)
201 |
202 | test: flash
203 | screen $(ESPPORT) 115200
204 |
205 | rebuild: clean all
206 |
207 | clean:
208 | $(Q) rm -f $(APP_AR)
209 | $(Q) rm -f $(TARGET_OUT)
210 | $(Q) rm -rf $(BUILD_DIR)
211 | $(Q) rm -rf $(BUILD_BASE)
212 | $(Q) rm -f $(FW_FILE_1)
213 | $(Q) rm -f $(FW_FILE_2)
214 | $(Q) rm -rf $(FW_BASE)
215 |
216 | $(foreach bdir,$(BUILD_DIR),$(eval $(call compile-objects,$(bdir))))
217 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # esp8266_ping
2 | A HC-SR04, HY-SRF05 driver and example for the esp8266.
3 | ```
4 | #include "ping/ping.h"
5 | ....
6 | static Ping_Data pingA;
7 | ....
8 | // setup
9 | int triggerPin = 0;
10 | int echoPin = 2;
11 | ping_init(&pingA, triggerPin, echoPin, PING_MM); // set the trigger and echo pin to the same number for one-pin mode
12 |
13 | ....
14 | // loop:
15 | float distance = 0;
16 | float maxDistance = 500;
17 | if (ping_pingDistance(&pingA, maxDistance, &distance) ) {
18 | os_printf("Response ~ %d mm \n", (int)distance);
19 | } else {
20 | os_printf("Failed to get any response.\n");
21 | }
22 | ```
23 |
24 | Makefile:
25 | ```
26 | MODULES = driver/stdout driver/easygpio driver/ping user
27 | ```
28 |
29 | ##Circuit
30 | The HC-SR04 is a 5V device, so you will (at the very least) need a [voltage divider](http://elinux.org/RPi_GPIO_Interface_Circuits#Voltage_divider) on the echo pin.
31 | Or even better: [a logic level shifter.](http://elinux.org/RPi_GPIO_Interface_Circuits#Level_Shifters)
32 |
33 | 
34 | ### single pin mode
35 |
36 | 
37 |
38 | If you want to run this in 'single pin mode' behind a logic level shifter you can connect the echo pin on the 3V3 side to the trigger GPIO via a 4KΩ:ish resistor. This works for a [a classic MOSFET level shifter](http://elinux.org/RPi_GPIO_Interface_Circuits#Classic_MOSFET_level_shifter) built out of two BSS138 and four 10KΩ resistors. Make sure that the esp GPIO reads low (input mode) when HC-SR04 echo pin is driven low. If it reads high the R2 resistor needs lower resistance.
39 |
40 | Wiring echo & trigger together on the 5V side does *not* work with a classic mosfet level shifter.
41 |
42 | 
43 |
44 | Another working solution is a voltage divider (5V to 3.3V) between HC-SR04 echo and ground. Connect HC-SR04 trigger and esp GPIO to the middle of the divider.
45 |
46 |
47 | ### other sensors
48 | The arduino library [newping](https://code.google.com/p/arduino-new-ping/) supports a whole range of ultrasonic sensors: SR04, SRF05, SRF06, DYP-ME007 & Parallax PING™. This without making any special hardware considerations in the code. So this library should work with those sensors as well.
49 |
50 | ## TODO
51 |
52 | * ~~inches~~
53 | * ~~single pin mode~~
54 | * ~~multiple sensors~~
55 | * ~~sdk v0.9.5 compability~~
56 | * ~~check compability SRF05~~ SRF05 works w/o any modifications
57 | * check compability SRF06
58 | * check compability DYP-ME007
59 | * check compability Parallax PING™
60 |
61 | ## License
62 |
63 | GPL V3
64 |
65 | The makefile is copied from [esp_mqtt.](https://github.com/tuanpmt/esp_mqtt)
66 |
67 | ###Building and installing:
68 |
69 | First you need to install the sdk and the easy way of doing that is to use [esp_open_sdk.](https://github.com/pfalcon/esp-open-sdk)
70 |
71 | You can put that anywhere you like (/opt/local/esp-open-sdk, /esptools etc etc)
72 |
73 | Then you could create a small ```setenv.sh``` file, containing the location of your newly compiled sdk and other platform specific info;
74 | ```
75 | export SDK_BASE=/opt/local/esp-open-sdk/sdk
76 | export PATH=${SDK_BASE}/../xtensa-lx106-elf/bin:${PATH}
77 | export ESPPORT=/dev/ttyO0
78 | ```
79 | (or setup your IDE to do the same)
80 |
81 | To make a clean build, flash and connect to the esp console you just do this in a shell:
82 | ```
83 | source setenv.sh # This is only needed once per session
84 | make clean && make test
85 | ```
86 |
87 | You won't be needing esptool, the makefile only uses esptool.py (provided by [esp_open_sdk](https://github.com/pfalcon/esp-open-sdk))
88 |
89 | I have tested this with sdk v1.5.2, v0.9.4 and v0.9.5 (linux & mac)
90 |
--------------------------------------------------------------------------------
/doc/arduino_one_pin.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eadf/esp8266_ping/e2b970d4ff52de8daf8d5dcf8d37e3ec24fd0413/doc/arduino_one_pin.png
--------------------------------------------------------------------------------
/doc/arduino_one_pin.sr:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eadf/esp8266_ping/e2b970d4ff52de8daf8d5dcf8d37e3ec24fd0413/doc/arduino_one_pin.sr
--------------------------------------------------------------------------------
/doc/arduino_two_pins.sr:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eadf/esp8266_ping/e2b970d4ff52de8daf8d5dcf8d37e3ec24fd0413/doc/arduino_two_pins.sr
--------------------------------------------------------------------------------
/doc/eps_two_pins.sr:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eadf/esp8266_ping/e2b970d4ff52de8daf8d5dcf8d37e3ec24fd0413/doc/eps_two_pins.sr
--------------------------------------------------------------------------------
/doc/esp_circuit_onepin.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eadf/esp8266_ping/e2b970d4ff52de8daf8d5dcf8d37e3ec24fd0413/doc/esp_circuit_onepin.png
--------------------------------------------------------------------------------
/doc/esp_circuit_onepin_voltage_divider.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eadf/esp8266_ping/e2b970d4ff52de8daf8d5dcf8d37e3ec24fd0413/doc/esp_circuit_onepin_voltage_divider.png
--------------------------------------------------------------------------------
/doc/esp_circuit_twopins.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eadf/esp8266_ping/e2b970d4ff52de8daf8d5dcf8d37e3ec24fd0413/doc/esp_circuit_twopins.png
--------------------------------------------------------------------------------
/doc/esp_two_pins.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eadf/esp8266_ping/e2b970d4ff52de8daf8d5dcf8d37e3ec24fd0413/doc/esp_two_pins.png
--------------------------------------------------------------------------------
/driver/Makefile:
--------------------------------------------------------------------------------
1 |
2 | #############################################################
3 | # Required variables for each makefile
4 | # Discard this section from all parent makefiles
5 | # Expected variables (with automatic defaults):
6 | # CSRCS (all "C" files in the dir)
7 | # SUBDIRS (all subdirs with a Makefile)
8 | # GEN_LIBS - list of libs to be generated ()
9 | # GEN_IMAGES - list of images to be generated ()
10 | # COMPONENTS_xxx - a list of libs/objs in the form
11 | # subdir/lib to be extracted and rolled up into
12 | # a generated lib/image xxx.a ()
13 | #
14 | ifndef PDIR
15 | GEN_LIBS = libdriver.a
16 | endif
17 |
18 |
19 | #############################################################
20 | # Configuration i.e. compile options etc.
21 | # Target specific stuff (defines etc.) goes in here!
22 | # Generally values applying to a tree are captured in the
23 | # makefile at its root level - these are then overridden
24 | # for a subtree within the makefile rooted therein
25 | #
26 | #DEFINES +=
27 |
28 | #############################################################
29 | # Recursion Magic - Don't touch this!!
30 | #
31 | # Each subtree potentially has an include directory
32 | # corresponding to the common APIs applicable to modules
33 | # rooted at that subtree. Accordingly, the INCLUDE PATH
34 | # of a module can only contain the include directories up
35 | # its parent path, and not its siblings
36 | #
37 | # Required for each makefile to inherit from the parent
38 | #
39 |
40 | INCLUDES := $(INCLUDES) -I $(PDIR)include
41 | INCLUDES += -I ./
42 | PDIR := ../$(PDIR)
43 | sinclude $(PDIR)Makefile
44 |
45 |
--------------------------------------------------------------------------------
/driver/easygpio/.gitignore:
--------------------------------------------------------------------------------
1 | # eclipse project files
2 | .cproject
3 | .project
4 | .settings
5 |
6 | # esp build files
7 | *.bin
8 |
9 | # Object files
10 | *.o
11 | *.ko
12 | *.obj
13 | *.elf
14 |
15 | # Precompiled Headers
16 | *.gch
17 | *.pch
18 |
19 | # Libraries
20 | *.lib
21 | *.a
22 | *.la
23 | *.lo
24 |
25 | # Shared objects (inc. Windows DLLs)
26 | *.dll
27 | *.so
28 | *.so.*
29 | *.dylib
30 |
31 | # Executables
32 | *.exe
33 | *.out
34 | *.app
35 | *.i*86
36 | *.x86_64
37 | *.hex
38 |
--------------------------------------------------------------------------------
/driver/easygpio/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
676 |
--------------------------------------------------------------------------------
/driver/easygpio/Makefile:
--------------------------------------------------------------------------------
1 |
2 | #############################################################
3 | # Required variables for each makefile
4 | # Discard this section from all parent makefiles
5 | # Expected variables (with automatic defaults):
6 | # CSRCS (all "C" files in the dir)
7 | # SUBDIRS (all subdirs with a Makefile)
8 | # GEN_LIBS - list of libs to be generated ()
9 | # GEN_IMAGES - list of images to be generated ()
10 | # COMPONENTS_xxx - a list of libs/objs in the form
11 | # subdir/lib to be extracted and rolled up into
12 | # a generated lib/image xxx.a ()
13 | #
14 | ifndef PDIR
15 | GEN_LIBS = libeasygpio.a
16 | endif
17 |
18 |
19 | #############################################################
20 | # Configuration i.e. compile options etc.
21 | # Target specific stuff (defines etc.) goes in here!
22 | # Generally values applying to a tree are captured in the
23 | # makefile at its root level - these are then overridden
24 | # for a subtree within the makefile rooted therein
25 | #
26 | #DEFINES +=
27 |
28 | #############################################################
29 | # Recursion Magic - Don't touch this!!
30 | #
31 | # Each subtree potentially has an include directory
32 | # corresponding to the common APIs applicable to modules
33 | # rooted at that subtree. Accordingly, the INCLUDE PATH
34 | # of a module can only contain the include directories up
35 | # its parent path, and not its siblings
36 | #
37 | # Required for each makefile to inherit from the parent
38 | #
39 |
40 | INCLUDES := $(INCLUDES) -I $(PDIR)include
41 | INCLUDES += -I ./
42 | PDIR := ../$(PDIR)
43 | sinclude $(PDIR)Makefile
44 |
45 |
--------------------------------------------------------------------------------
/driver/easygpio/README.md:
--------------------------------------------------------------------------------
1 | # esp8266_easygpio
2 | An easy way of setting up esp8266 GPIO pins.
3 |
4 | I grew tired of juggling gpio pin numbers, gpio names and gpio functions. So i created this little helper library.
5 |
6 | To setup a pin as a GPIO input you can now just do this:
7 |
8 | ```
9 | #include "easygpio/easygpio.h"
10 | ...
11 | bool easygpio_pinMode(0, EASYGPIO_NOPULL, EASYGPIO_INPUT);
12 | ```
13 |
14 | Same thing with outputs:
15 | ```
16 | bool easygpio_pinMode(1, EASYGPIO_NOPULL, EASYGPIO_OUTPUT);
17 | ```
18 | pullStatus does not apply to output pins.
19 |
20 | You might still need the gpio_name and func. No problem:
21 | ```
22 | bool easygpio_getGPIONameFunc(uint8_t gpio_pin, uint32_t *gpio_name, uint8_t *gpio_func)
23 | ```
24 |
25 | You can even setup an interrupt handler:
26 | ```
27 | bool easygpio_attachInterrupt(uint8_t gpio_pin, EasyGPIO_PullStatus pullStatus, void (*interruptHandler)(void* arg), void *interruptArg)
28 | ```
29 |
30 | You can use the methods and macros defined in gpio.h (from the sdk) to access the 'standard' gpio pins (not GPIO16).
31 | ```
32 | #include "gpio.h"
33 | ...
34 | GPIO_OUTPUT_SET(gpio_no, bit_value) // GPIO_OUTPUT_SET(0,1) sets gpio0 to high
35 | GPIO_DIS_OUTPUT(gpio_no) // GPIO_DIS_OUTPUT(2) turns off output on gpio2
36 | GPIO_INPUT_GET(gpio_no) // GPIO_INPUT_GET(12) returns the input value of gpio12
37 | ```
38 |
39 | To access *all* of the pins in an uniform way you can use
40 | ```
41 | uint8_t easygpio_inputGet(uint8_t gpio_pin);
42 | void easygpio_outputSet(uint8_t gpio_pin, uint8_t value);
43 | ```
44 | However, you should not rely on that these methods will change input/output status of a pin (like the gpio.h macros does).
45 |
46 | e.g. if you call ```easygpio_outputSet``` on an input pin, the pin may or may not remain an input. This is because of performance and uniformity reasons. ```easygpio_outputSet(16,1)``` will never flip gpio16 to an output, and we can't have access methods with different semantics depending on pin number).
47 |
48 | So if you need to change the input/output mode of a pin on the fly, you can use ```easygpio_outputDisable()``` or ```easygpio_outputEnable()```.
49 |
50 | ###Available pins
51 |
52 | Pin number | Note
53 | -----------|------
54 | GPIO0 | this pin selects bootmode [(pull up for *normal* boot)](https://github.com/esp8266/esp8266-wiki/wiki/Boot-Process#esp-boot-modes)
55 | GPIO1 | normally UART0 TX
56 | GPIO2 | this pin selects bootmode [(pull up for *normal* boot)](https://github.com/esp8266/esp8266-wiki/wiki/Boot-Process#esp-boot-modes)
57 | GPIO3 | normally UART0 RX (you can use [stdout](https://github.com/eadf/esp8266_stdout) to use it as GPIO)
58 | GPIO4 | sometimes mislabeled as GPIO5 (esp-12)
59 | GPIO5 | sometimes mislabeled as GPIO4 (esp-12)
60 | GPIO12 |
61 | GPIO13 |
62 | GPIO14 |
63 | GPIO15 | this pin selects bootmode [(pull down for *normal* boot)](https://github.com/esp8266/esp8266-wiki/wiki/Boot-Process#esp-boot-modes)
64 | GPIO16 | requires easygpio_inputGet() & easygpio_outputSet() access methods (no interrupt on this pin)
65 |
66 | All the GPIOs mentioned in ```easgle_soc.h``` are supported, but maybe we should not mess with the internal SPI pins for GPIO.
67 |
68 | ## Usage
69 |
70 | The project has been designed for easy reuse, just create a folder with these files in it ([git subtree](http://blogs.atlassian.com/2013/05/alternatives-to-git-submodule-git-subtree) works great for that purpose). Then point your ```MODULES``` variable (or whatever subdirectory construct you use) in the ```Makefile``` to that folder . If you find yourself manually copying these individial .c and .h files - you're doing it wrong.
71 |
72 | See an example on how this library can be used [here](https://github.com/eadf/esp8266_digoleserial), [here](https://github.com/eadf/esp_mqtt_lcd), [here](https://github.com/eadf/esp8266_ping), [here](https://github.com/eadf/esp_mqtt_ports) - bha.. practically all of my esp projects uses it.
73 |
74 | ## Todo
75 | * Find the correct ```READ_PERI_REG()``` address for ```easygpio_inputGet()```, now it's simply using ```GPIO_INPUT_GET()```
76 |
77 | ## Required:
78 |
79 | esp-open-sdk-v0.9.5 or higher.
80 |
81 | I've successfully tested this with sdk v1.5.2 and v0.9.5 (linux & mac).
82 |
--------------------------------------------------------------------------------
/driver/easygpio/easygpio.c:
--------------------------------------------------------------------------------
1 | /*
2 | * easygpio.c
3 | *
4 | * Copyright (c) 2015, eadf (https://github.com/eadf)
5 | * All rights reserved.
6 | *
7 | * Redistribution and use in source and binary forms, with or without
8 | * modification, are permitted provided that the following conditions are met:
9 | *
10 | * * Redistributions of source code must retain the above copyright notice,
11 | * this list of conditions and the following disclaimer.
12 | * * Redistributions in binary form must reproduce the above copyright
13 | * notice, this list of conditions and the following disclaimer in the
14 | * documentation and/or other materials provided with the distribution.
15 | * * Neither the name of Redis nor the names of its contributors may be used
16 | * to endorse or promote products derived from this software without
17 | * specific prior written permission.
18 | *
19 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 | * POSSIBILITY OF SUCH DAMAGE.
30 | */
31 |
32 | #include "easygpio/easygpio.h"
33 | #include "gpio.h"
34 | #include "osapi.h"
35 | #include "ets_sys.h"
36 |
37 | #define EASYGPIO_USE_GPIO_INPUT_GET
38 |
39 | static void ICACHE_FLASH_ATTR
40 | gpio16_output_conf(void) {
41 | WRITE_PERI_REG(PAD_XPD_DCDC_CONF,
42 | (READ_PERI_REG(PAD_XPD_DCDC_CONF) & 0xffffffbcUL) | 0x1UL); // mux configuration for XPD_DCDC to output rtc_gpio0
43 |
44 | WRITE_PERI_REG(RTC_GPIO_CONF,
45 | (READ_PERI_REG(RTC_GPIO_CONF) & 0xfffffffeUL) | 0x0UL); //mux configuration for out enable
46 |
47 | WRITE_PERI_REG(RTC_GPIO_ENABLE,
48 | (READ_PERI_REG(RTC_GPIO_ENABLE) & 0xfffffffeUL) | 0x1UL); //out enable
49 | }
50 |
51 | static void ICACHE_FLASH_ATTR
52 | gpio16_input_conf(void) {
53 | WRITE_PERI_REG(PAD_XPD_DCDC_CONF,
54 | (READ_PERI_REG(PAD_XPD_DCDC_CONF) & 0xffffffbcUL) | 0x1UL); // mux configuration for XPD_DCDC and rtc_gpio0 connection
55 |
56 | WRITE_PERI_REG(RTC_GPIO_CONF,
57 | (READ_PERI_REG(RTC_GPIO_CONF) & 0xfffffffeUL) | 0x0UL); //mux configuration for out enable
58 |
59 | WRITE_PERI_REG(RTC_GPIO_ENABLE,
60 | READ_PERI_REG(RTC_GPIO_ENABLE) & 0xfffffffeUL); //out disable
61 | }
62 |
63 | /**
64 | * Returns the number of active pins in the gpioMask.
65 | */
66 | uint8_t ICACHE_FLASH_ATTR
67 | easygpio_countBits(uint32_t gpioMask) {
68 |
69 | uint8_t i=0;
70 | uint8_t numberOfPins=0;
71 | for (i=0; i<32; i++){
72 | numberOfPins += (gpioMask & BIT(i))?1:0;
73 | }
74 | return numberOfPins;
75 | }
76 |
77 | /**
78 | * Returns the gpio name and func for a specific pin.
79 | */
80 | bool ICACHE_FLASH_ATTR
81 | easygpio_getGPIONameFunc(uint8_t gpio_pin, uint32_t *gpio_name, uint8_t *gpio_func) {
82 |
83 | if (gpio_pin == 6 || gpio_pin == 7 || gpio_pin == 8 || gpio_pin == 11 || gpio_pin >= 17) {
84 | os_printf("easygpio_getGPIONameFunc Error: There is no GPIO%d, check your code\n", gpio_pin);
85 | return false;
86 | }
87 | if (gpio_pin == 16) {
88 | os_printf("easygpio_getGPIONameFunc Error: GPIO16 does not have gpio_name and gpio_func\n");
89 | return false;
90 | }
91 | switch ( gpio_pin ) {
92 | case 0:
93 | *gpio_func = FUNC_GPIO0;
94 | *gpio_name = PERIPHS_IO_MUX_GPIO0_U;
95 | return true;
96 | case 1:
97 | *gpio_func = FUNC_GPIO1;
98 | *gpio_name = PERIPHS_IO_MUX_U0TXD_U;
99 | return true;
100 | case 2:
101 | *gpio_func = FUNC_GPIO2;
102 | *gpio_name = PERIPHS_IO_MUX_GPIO2_U;
103 | return true;
104 | case 3:
105 | *gpio_func = FUNC_GPIO3;
106 | *gpio_name = PERIPHS_IO_MUX_U0RXD_U;
107 | return true;
108 | case 4:
109 | *gpio_func = FUNC_GPIO4;
110 | *gpio_name = PERIPHS_IO_MUX_GPIO4_U;
111 | return true;
112 | case 5:
113 | *gpio_func = FUNC_GPIO5;
114 | *gpio_name = PERIPHS_IO_MUX_GPIO5_U;
115 | return true;
116 | case 9:
117 | *gpio_func = FUNC_GPIO9;
118 | *gpio_name = PERIPHS_IO_MUX_SD_DATA2_U;
119 | return true;
120 | case 10:
121 | *gpio_func = FUNC_GPIO10;
122 | *gpio_name = PERIPHS_IO_MUX_SD_DATA3_U;
123 | return true;
124 | case 12:
125 | *gpio_func = FUNC_GPIO12;
126 | *gpio_name = PERIPHS_IO_MUX_MTDI_U;
127 | return true;
128 | case 13:
129 | *gpio_func = FUNC_GPIO13;
130 | *gpio_name = PERIPHS_IO_MUX_MTCK_U;
131 | return true;
132 | case 14:
133 | *gpio_func = FUNC_GPIO14;
134 | *gpio_name = PERIPHS_IO_MUX_MTMS_U;
135 | return true;
136 | case 15:
137 | *gpio_func = FUNC_GPIO15;
138 | *gpio_name = PERIPHS_IO_MUX_MTDO_U;
139 | return true;
140 | default:
141 | return false;
142 | }
143 | return true;
144 | }
145 |
146 | /**
147 | * Sets the pull up registers for a pin.
148 | */
149 | static void ICACHE_FLASH_ATTR
150 | easygpio_setupPullsByName(uint32_t gpio_name, EasyGPIO_PullStatus pullStatus) {
151 |
152 | if (EASYGPIO_PULLUP == pullStatus) {
153 | PIN_PULLUP_EN(gpio_name);
154 | } else {
155 | PIN_PULLUP_DIS(gpio_name);
156 | }
157 | }
158 |
159 | /**
160 | * Sets the pull registers for a pin.
161 | */
162 | bool ICACHE_FLASH_ATTR
163 | easygpio_pullMode(uint8_t gpio_pin, EasyGPIO_PullStatus pullStatus) {
164 | uint32_t gpio_name;
165 | uint8_t gpio_func;
166 |
167 | if (!easygpio_getGPIONameFunc(gpio_pin, &gpio_name, &gpio_func) ) {
168 | return false;
169 | }
170 |
171 | easygpio_setupPullsByName(gpio_name, pullStatus);
172 | return true;
173 | }
174 |
175 | /**
176 | * Sets the 'gpio_pin' pin as a GPIO and sets the pull register for that pin.
177 | * 'pullStatus' has no effect on output pins or GPIO16
178 | */
179 | bool ICACHE_FLASH_ATTR
180 | easygpio_pinMode(uint8_t gpio_pin, EasyGPIO_PullStatus pullStatus, EasyGPIO_PinMode pinMode) {
181 | uint32_t gpio_name;
182 | uint8_t gpio_func;
183 |
184 | if (16==gpio_pin) {
185 | // ignoring pull status on GPIO16 for now
186 | if (EASYGPIO_OUTPUT == pinMode) {
187 | gpio16_output_conf();
188 | } else {
189 | gpio16_input_conf();
190 | }
191 | return true;
192 | } else if (!easygpio_getGPIONameFunc(gpio_pin, &gpio_name, &gpio_func) ) {
193 | return false;
194 | }
195 |
196 | PIN_FUNC_SELECT(gpio_name, gpio_func);
197 | easygpio_setupPullsByName(gpio_name, pullStatus);
198 |
199 | if (EASYGPIO_OUTPUT != pinMode) {
200 | GPIO_DIS_OUTPUT(GPIO_ID_PIN(gpio_pin));
201 | } else {
202 | // must enable the pin or else the WRITE_PERI_REG won't work
203 | gpio_output_set(0, 0, BIT(GPIO_ID_PIN(gpio_pin)),0);
204 | }
205 | return true;
206 | }
207 |
208 | /**
209 | * Sets the 'gpio_pin' pin as a GPIO and sets the interrupt to trigger on that pin.
210 | * The 'interruptArg' is the function argument that will be sent to your interruptHandler
211 | */
212 | bool ICACHE_FLASH_ATTR
213 | easygpio_attachInterrupt(uint8_t gpio_pin, EasyGPIO_PullStatus pullStatus, void (*interruptHandler)(void *arg), void *interruptArg) {
214 | uint32_t gpio_name;
215 | uint8_t gpio_func;
216 |
217 | if (gpio_pin == 16) {
218 | os_printf("easygpio_setupInterrupt Error: GPIO16 does not have interrupts\n");
219 | return false;
220 | }
221 | if (!easygpio_getGPIONameFunc(gpio_pin, &gpio_name, &gpio_func) ) {
222 | return false;
223 | }
224 |
225 | ETS_GPIO_INTR_ATTACH(interruptHandler, interruptArg);
226 | ETS_GPIO_INTR_DISABLE();
227 |
228 | PIN_FUNC_SELECT(gpio_name, gpio_func);
229 |
230 | easygpio_setupPullsByName(gpio_name, pullStatus);
231 |
232 | // disable output
233 | GPIO_DIS_OUTPUT(gpio_pin);
234 |
235 | gpio_register_set(GPIO_PIN_ADDR(gpio_pin), GPIO_PIN_INT_TYPE_SET(GPIO_PIN_INTR_DISABLE)
236 | | GPIO_PIN_PAD_DRIVER_SET(GPIO_PAD_DRIVER_DISABLE)
237 | | GPIO_PIN_SOURCE_SET(GPIO_AS_PIN_SOURCE));
238 |
239 | //clear gpio14 status
240 | GPIO_REG_WRITE(GPIO_STATUS_W1TC_ADDRESS, BIT(gpio_pin));
241 | ETS_GPIO_INTR_ENABLE();
242 |
243 | return true;
244 | }
245 |
246 | /**
247 | * Detach the interrupt handler from the 'gpio_pin' pin.
248 | */
249 | bool ICACHE_FLASH_ATTR
250 | easygpio_detachInterrupt(uint8_t gpio_pin) {
251 |
252 | if (gpio_pin == 16) {
253 | os_printf("easygpio_setupInterrupt Error: GPIO16 does not have interrupts\n");
254 | return false;
255 | }
256 |
257 | // Don't know how to detach interrupt, yet.
258 | // Quick and dirty fix - just disable the interrupt
259 | gpio_pin_intr_state_set(GPIO_ID_PIN(gpio_pin), GPIO_PIN_INTR_DISABLE);
260 | return true;
261 | }
262 |
263 | /**
264 | * Uniform way of setting GPIO output value. Handles GPIO 0-16.
265 | *
266 | * You can not rely on that this function will switch the gpio to an output like GPIO_OUTPUT_SET does.
267 | * Use easygpio_outputEnable() to change an input gpio to output mode.
268 | */
269 | void
270 | easygpio_outputSet(uint8_t gpio_pin, uint8_t value) {
271 | if (16==gpio_pin) {
272 | WRITE_PERI_REG(RTC_GPIO_OUT,
273 | (READ_PERI_REG(RTC_GPIO_OUT) & 0xfffffffeUL) | (0x1UL & value));
274 | } else {
275 | #ifdef EASYGPIO_USE_GPIO_OUTPUT_SET
276 | GPIO_OUTPUT_SET(GPIO_ID_PIN(gpio_pin), value);
277 | #else
278 | if (value&1){
279 | WRITE_PERI_REG( PERIPHS_GPIO_BASEADDR, READ_PERI_REG(PERIPHS_GPIO_BASEADDR) | BIT(gpio_pin));
280 | } else {
281 | WRITE_PERI_REG( PERIPHS_GPIO_BASEADDR, READ_PERI_REG(PERIPHS_GPIO_BASEADDR) & ~BIT(gpio_pin));
282 | }
283 | #endif
284 | }
285 | }
286 |
287 | /**
288 | * Uniform way of getting GPIO input value. Handles GPIO 0-16.
289 | * The pin must be initiated with easygpio_pinMode() so that the pin mux is setup as a gpio in the first place.
290 | * If you know that you won't be using GPIO16 then you'd better off by just using GPIO_INPUT_GET().
291 | */
292 | uint8_t
293 | easygpio_inputGet(uint8_t gpio_pin) {
294 | if (16==gpio_pin) {
295 | return (READ_PERI_REG(RTC_GPIO_IN_DATA) & 1UL);
296 | } else {
297 | #ifdef EASYGPIO_USE_GPIO_INPUT_GET
298 | return GPIO_INPUT_GET(GPIO_ID_PIN(gpio_pin));
299 | #else
300 | // this does *not* work, maybe GPIO_IN_ADDRESS is the wrong address
301 | return ((GPIO_REG_READ(GPIO_IN_ADDRESS) > gpio_pin) & 1UL);
302 | #endif
303 | }
304 | }
305 |
306 | /**
307 | * Uniform way of turning an output GPIO pin into input mode. Handles GPIO 0-16.
308 | * The pin must be initiated with easygpio_pinMode() so that the pin mux is setup as a gpio in the first place.
309 | * This function does the same thing as GPIO_DIS_OUTPUT, but works on GPIO16 too.
310 | */
311 | void easygpio_outputDisable(uint8_t gpio_pin) {
312 | if (16==gpio_pin) {
313 | WRITE_PERI_REG(RTC_GPIO_ENABLE,
314 | READ_PERI_REG(RTC_GPIO_ENABLE) & 0xfffffffeUL); //out disable
315 | } else {
316 | GPIO_DIS_OUTPUT(GPIO_ID_PIN(gpio_pin));
317 | }
318 | }
319 |
320 | /**
321 | * Uniform way of turning an input GPIO pin into output mode. Handles GPIO 0-16.
322 | * The pin must be initiated with easygpio_pinMode() so that the pin mux is setup as a gpio in the first place.
323 | *
324 | * This function:
325 | * - should only be used to convert a input pin into an output pin.
326 | * - is a little bit slower than easygpio_outputSet() so you should use that
327 | * function to just change output value.
328 | * - does the same thing as GPIO_OUTPUT_SET, but works on GPIO16 too.
329 | */
330 | void easygpio_outputEnable(uint8_t gpio_pin, uint8_t value) {
331 | if (16==gpio_pin) {
332 | // write the value before flipping to output
333 | // - so we don't flash previous value for a few ns.
334 | WRITE_PERI_REG(RTC_GPIO_OUT,
335 | (READ_PERI_REG(RTC_GPIO_OUT) & 0xfffffffeUL) | (0x1UL & value));
336 |
337 | WRITE_PERI_REG(RTC_GPIO_ENABLE,
338 | (READ_PERI_REG(RTC_GPIO_ENABLE) & 0xfffffffeUL) | 0x1UL); //out enable
339 |
340 | } else {
341 | GPIO_OUTPUT_SET(GPIO_ID_PIN(gpio_pin), value);
342 | }
343 | }
344 |
--------------------------------------------------------------------------------
/driver/easygpio/examples/dependencies/easygpio/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eadf/esp8266_ping/e2b970d4ff52de8daf8d5dcf8d37e3ec24fd0413/driver/easygpio/examples/dependencies/easygpio/.keep
--------------------------------------------------------------------------------
/driver/easygpio/examples/dependencies/stdout/.gitignore:
--------------------------------------------------------------------------------
1 | # Object files
2 | *.o
3 | *.ko
4 | *.obj
5 | *.elf
6 |
7 | # Precompiled Headers
8 | *.gch
9 | *.pch
10 |
11 | # Libraries
12 | *.lib
13 | *.a
14 | *.la
15 | *.lo
16 |
17 | # Shared objects (inc. Windows DLLs)
18 | *.dll
19 | *.so
20 | *.so.*
21 | *.dylib
22 |
23 | # Executables
24 | *.exe
25 | *.out
26 | *.app
27 | *.i*86
28 | *.x86_64
29 | *.hex
30 |
--------------------------------------------------------------------------------
/driver/easygpio/examples/dependencies/stdout/README.md:
--------------------------------------------------------------------------------
1 | # esp8266_stdout
2 | A clone of Jeroen Domburg's () stdout driver.
3 | It's an alternative uart driver that only uses the TX pin, so the RX pin is free for GPIO use.
4 |
5 | Needless to say, but this driver can only transmit.
6 |
7 | ###License:
8 | "THE BEER-WARE LICENSE" (Revision 42):
9 | Jeroen Domburg wrote this file. As long as you retain
10 | this notice you can do whatever you want with this stuff. If we meet some day,
11 | and you think this stuff is worth it, you can buy me a beer in return.
12 |
13 |
14 |
--------------------------------------------------------------------------------
/driver/easygpio/examples/dependencies/stdout/include/stdout/stdout.h:
--------------------------------------------------------------------------------
1 | //Stupid bit of code that does the bare minimum to make os_printf work.
2 |
3 | /*
4 | * ----------------------------------------------------------------------------
5 | * "THE BEER-WARE LICENSE" (Revision 42):
6 | * Jeroen Domburg wrote this file. As long as you retain
7 | * this notice you can do whatever you want with this stuff. If we meet some day,
8 | * and you think this stuff is worth it, you can buy me a beer in return.
9 | * ----------------------------------------------------------------------------
10 | */
11 |
12 | void stdout_init(void);
13 |
--------------------------------------------------------------------------------
/driver/easygpio/examples/dependencies/stdout/include/stdout/uart_hw.h:
--------------------------------------------------------------------------------
1 | //Generated at 2012-07-03 18:44:06
2 | /*
3 | * Copyright (c) 2010 - 2011 Espressif System
4 | *
5 | */
6 |
7 | #ifndef UART_REGISTER_H_INCLUDED
8 | #define UART_REGISTER_H_INCLUDED
9 | #define REG_UART_BASE( i ) (0x60000000+(i)*0xf00)
10 | //version value:32'h062000
11 |
12 | #define UART_FIFO( i ) (REG_UART_BASE( i ) + 0x0)
13 | #define UART_RXFIFO_RD_BYTE 0x000000FF
14 | #define UART_RXFIFO_RD_BYTE_S 0
15 |
16 | #define UART_INT_RAW( i ) (REG_UART_BASE( i ) + 0x4)
17 | #define UART_RXFIFO_TOUT_INT_RAW (BIT(8))
18 | #define UART_BRK_DET_INT_RAW (BIT(7))
19 | #define UART_CTS_CHG_INT_RAW (BIT(6))
20 | #define UART_DSR_CHG_INT_RAW (BIT(5))
21 | #define UART_RXFIFO_OVF_INT_RAW (BIT(4))
22 | #define UART_FRM_ERR_INT_RAW (BIT(3))
23 | #define UART_PARITY_ERR_INT_RAW (BIT(2))
24 | #define UART_TXFIFO_EMPTY_INT_RAW (BIT(1))
25 | #define UART_RXFIFO_FULL_INT_RAW (BIT(0))
26 |
27 | #define UART_INT_ST( i ) (REG_UART_BASE( i ) + 0x8)
28 | #define UART_RXFIFO_TOUT_INT_ST (BIT(8))
29 | #define UART_BRK_DET_INT_ST (BIT(7))
30 | #define UART_CTS_CHG_INT_ST (BIT(6))
31 | #define UART_DSR_CHG_INT_ST (BIT(5))
32 | #define UART_RXFIFO_OVF_INT_ST (BIT(4))
33 | #define UART_FRM_ERR_INT_ST (BIT(3))
34 | #define UART_PARITY_ERR_INT_ST (BIT(2))
35 | #define UART_TXFIFO_EMPTY_INT_ST (BIT(1))
36 | #define UART_RXFIFO_FULL_INT_ST (BIT(0))
37 |
38 | #define UART_INT_ENA( i ) (REG_UART_BASE( i ) + 0xC)
39 | #define UART_RXFIFO_TOUT_INT_ENA (BIT(8))
40 | #define UART_BRK_DET_INT_ENA (BIT(7))
41 | #define UART_CTS_CHG_INT_ENA (BIT(6))
42 | #define UART_DSR_CHG_INT_ENA (BIT(5))
43 | #define UART_RXFIFO_OVF_INT_ENA (BIT(4))
44 | #define UART_FRM_ERR_INT_ENA (BIT(3))
45 | #define UART_PARITY_ERR_INT_ENA (BIT(2))
46 | #define UART_TXFIFO_EMPTY_INT_ENA (BIT(1))
47 | #define UART_RXFIFO_FULL_INT_ENA (BIT(0))
48 |
49 | #define UART_INT_CLR( i ) (REG_UART_BASE( i ) + 0x10)
50 | #define UART_RXFIFO_TOUT_INT_CLR (BIT(8))
51 | #define UART_BRK_DET_INT_CLR (BIT(7))
52 | #define UART_CTS_CHG_INT_CLR (BIT(6))
53 | #define UART_DSR_CHG_INT_CLR (BIT(5))
54 | #define UART_RXFIFO_OVF_INT_CLR (BIT(4))
55 | #define UART_FRM_ERR_INT_CLR (BIT(3))
56 | #define UART_PARITY_ERR_INT_CLR (BIT(2))
57 | #define UART_TXFIFO_EMPTY_INT_CLR (BIT(1))
58 | #define UART_RXFIFO_FULL_INT_CLR (BIT(0))
59 |
60 | #define UART_CLKDIV( i ) (REG_UART_BASE( i ) + 0x14)
61 | #define UART_CLKDIV_CNT 0x000FFFFF
62 | #define UART_CLKDIV_S 0
63 |
64 | #define UART_AUTOBAUD( i ) (REG_UART_BASE( i ) + 0x18)
65 | #define UART_GLITCH_FILT 0x000000FF
66 | #define UART_GLITCH_FILT_S 8
67 | #define UART_AUTOBAUD_EN (BIT(0))
68 |
69 | #define UART_STATUS( i ) (REG_UART_BASE( i ) + 0x1C)
70 | #define UART_TXD (BIT(31))
71 | #define UART_RTSN (BIT(30))
72 | #define UART_DTRN (BIT(29))
73 | #define UART_TXFIFO_CNT 0x000000FF
74 | #define UART_TXFIFO_CNT_S 16
75 | #define UART_RXD (BIT(15))
76 | #define UART_CTSN (BIT(14))
77 | #define UART_DSRN (BIT(13))
78 | #define UART_RXFIFO_CNT 0x000000FF
79 | #define UART_RXFIFO_CNT_S 0
80 |
81 | #define UART_CONF0( i ) (REG_UART_BASE( i ) + 0x20)
82 | #define UART_TXFIFO_RST (BIT(18))
83 | #define UART_RXFIFO_RST (BIT(17))
84 | #define UART_IRDA_EN (BIT(16))
85 | #define UART_TX_FLOW_EN (BIT(15))
86 | #define UART_LOOPBACK (BIT(14))
87 | #define UART_IRDA_RX_INV (BIT(13))
88 | #define UART_IRDA_TX_INV (BIT(12))
89 | #define UART_IRDA_WCTL (BIT(11))
90 | #define UART_IRDA_TX_EN (BIT(10))
91 | #define UART_IRDA_DPLX (BIT(9))
92 | #define UART_TXD_BRK (BIT(8))
93 | #define UART_SW_DTR (BIT(7))
94 | #define UART_SW_RTS (BIT(6))
95 | #define UART_STOP_BIT_NUM 0x00000003
96 | #define UART_STOP_BIT_NUM_S 4
97 | #define UART_BIT_NUM 0x00000003
98 | #define UART_BIT_NUM_S 2
99 | #define UART_PARITY_EN (BIT(1))
100 | #define UART_PARITY (BIT(0))
101 |
102 | #define UART_CONF1( i ) (REG_UART_BASE( i ) + 0x24)
103 | #define UART_RX_TOUT_EN (BIT(31))
104 | #define UART_RX_TOUT_THRHD 0x0000007F
105 | #define UART_RX_TOUT_THRHD_S 24
106 | #define UART_RX_FLOW_EN (BIT(23))
107 | #define UART_RX_FLOW_THRHD 0x0000007F
108 | #define UART_RX_FLOW_THRHD_S 16
109 | #define UART_TXFIFO_EMPTY_THRHD 0x0000007F
110 | #define UART_TXFIFO_EMPTY_THRHD_S 8
111 | #define UART_RXFIFO_FULL_THRHD 0x0000007F
112 | #define UART_RXFIFO_FULL_THRHD_S 0
113 |
114 | #define UART_LOWPULSE( i ) (REG_UART_BASE( i ) + 0x28)
115 | #define UART_LOWPULSE_MIN_CNT 0x000FFFFF
116 | #define UART_LOWPULSE_MIN_CNT_S 0
117 |
118 | #define UART_HIGHPULSE( i ) (REG_UART_BASE( i ) + 0x2C)
119 | #define UART_HIGHPULSE_MIN_CNT 0x000FFFFF
120 | #define UART_HIGHPULSE_MIN_CNT_S 0
121 |
122 | #define UART_PULSE_NUM( i ) (REG_UART_BASE( i ) + 0x30)
123 | #define UART_PULSE_NUM_CNT 0x0003FF
124 | #define UART_PULSE_NUM_CNT_S 0
125 |
126 | #define UART_DATE( i ) (REG_UART_BASE( i ) + 0x78)
127 | #define UART_ID( i ) (REG_UART_BASE( i ) + 0x7C)
128 | #endif // UART_REGISTER_H_INCLUDED
129 |
130 | #define RX_BUFF_SIZE 256
131 | #define TX_BUFF_SIZE 100
132 | #define UART0 0
133 | #define UART1 1
134 |
135 | typedef enum {
136 | FIVE_BITS = 0x0,
137 | SIX_BITS = 0x1,
138 | SEVEN_BITS = 0x2,
139 | EIGHT_BITS = 0x3
140 | } UartBitsNum4Char;
141 |
142 | typedef enum {
143 | ONE_STOP_BIT = 0,
144 | ONE_HALF_STOP_BIT = BIT2,
145 | TWO_STOP_BIT = BIT2
146 | } UartStopBitsNum;
147 |
148 | typedef enum {
149 | NONE_BITS = 0,
150 | ODD_BITS = 0,
151 | EVEN_BITS = BIT4
152 | } UartParityMode;
153 |
154 | typedef enum {
155 | STICK_PARITY_DIS = 0,
156 | STICK_PARITY_EN = BIT3 | BIT5
157 | } UartExistParity;
158 |
159 | typedef enum {
160 | BIT_RATE_9600 = 9600,
161 | BIT_RATE_19200 = 19200,
162 | BIT_RATE_38400 = 38400,
163 | BIT_RATE_57600 = 57600,
164 | BIT_RATE_74880 = 74880,
165 | BIT_RATE_115200 = 115200,
166 | BIT_RATE_230400 = 230400,
167 | BIT_RATE_460800 = 460800,
168 | BIT_RATE_921600 = 921600
169 | } UartBautRate;
170 |
171 | typedef enum {
172 | NONE_CTRL,
173 | HARDWARE_CTRL,
174 | XON_XOFF_CTRL
175 | } UartFlowCtrl;
176 |
177 | typedef enum {
178 | EMPTY,
179 | UNDER_WRITE,
180 | WRITE_OVER
181 | } RcvMsgBuffState;
182 |
183 | typedef struct {
184 | uint32 TrxBuffSize;
185 | uint8 *pTrxBuff;
186 | } TrxMsgBuff;
187 |
188 | typedef enum {
189 | BAUD_RATE_DET,
190 | WAIT_SYNC_FRM,
191 | SRCH_MSG_HEAD,
192 | RCV_MSG_BODY,
193 | RCV_ESC_CHAR,
194 | } RcvMsgState;
195 |
196 |
--------------------------------------------------------------------------------
/driver/easygpio/examples/dependencies/stdout/stdout.c:
--------------------------------------------------------------------------------
1 | //Stupid bit of code that does the bare minimum to make os_printf work.
2 |
3 | /*
4 | * ----------------------------------------------------------------------------
5 | * "THE BEER-WARE LICENSE" (Revision 42):
6 | * Jeroen Domburg wrote this file. As long as you retain
7 | * this notice you can do whatever you want with this stuff. If we meet some day,
8 | * and you think this stuff is worth it, you can buy me a beer in return.
9 | * ----------------------------------------------------------------------------
10 | */
11 | #include "stdout/stdout.h"
12 | #include "ets_sys.h"
13 | #include "osapi.h"
14 | #include "stdout/uart_hw.h"
15 |
16 | static void ICACHE_FLASH_ATTR stdoutUartTxd(char c) {
17 | //Wait until there is room in the FIFO
18 | while (((READ_PERI_REG(UART_STATUS(0))>>UART_TXFIFO_CNT_S)&UART_TXFIFO_CNT)>=126) ;
19 | //Send the character
20 | WRITE_PERI_REG(UART_FIFO(0), c);
21 | }
22 |
23 | static void ICACHE_FLASH_ATTR stdoutPutchar(char c) {
24 | //convert \n -> \r\n
25 | if (c=='\n') stdoutUartTxd('\r');
26 | stdoutUartTxd(c);
27 | }
28 |
29 |
30 | void ICACHE_FLASH_ATTR
31 | stdout_init() {
32 | //Enable TxD pin
33 | PIN_PULLUP_DIS(PERIPHS_IO_MUX_U0TXD_U);
34 | PIN_FUNC_SELECT(PERIPHS_IO_MUX_U0TXD_U, FUNC_U0TXD);
35 |
36 | //Set baud rate and other serial parameters to 115200,n,8,1
37 | uart_div_modify(0, UART_CLK_FREQ/BIT_RATE_115200);
38 | WRITE_PERI_REG(UART_CONF0(0), (STICK_PARITY_DIS)|(ONE_STOP_BIT << UART_STOP_BIT_NUM_S)| \
39 | (EIGHT_BITS << UART_BIT_NUM_S));
40 |
41 | //Reset tx & rx fifo
42 | SET_PERI_REG_MASK(UART_CONF0(0), UART_RXFIFO_RST|UART_TXFIFO_RST);
43 | CLEAR_PERI_REG_MASK(UART_CONF0(0), UART_RXFIFO_RST|UART_TXFIFO_RST);
44 | //Clear pending interrupts
45 | WRITE_PERI_REG(UART_INT_CLR(0), 0xffff);
46 |
47 | //Install our own putchar handler
48 | os_install_putc1((void *)stdoutPutchar);
49 | }
50 |
--------------------------------------------------------------------------------
/driver/easygpio/examples/readgpio/Makefile:
--------------------------------------------------------------------------------
1 | # Changelog
2 | # Changed the variables to include the header file directory
3 | # Added global var for the XTENSA tool root
4 | #
5 | # This make file still needs some work.
6 | #
7 | #
8 | # Output directors to store intermediate compiled files
9 | # relative to the project directory
10 | BUILD_BASE = build
11 | FW_BASE = firmware
12 | ESPTOOL = esptool.py
13 |
14 |
15 | # name for the target project
16 | TARGET = app
17 |
18 | # linker script used for the above linkier step
19 | LD_SCRIPT = eagle.app.v6.ld
20 |
21 | # we create two different files for uploading into the flash
22 | # these are the names and options to generate them
23 | FW_1 = 0x00000
24 | FW_2 = 0x40000
25 |
26 | FLAVOR ?= release
27 |
28 |
29 | #############################################################
30 | # Select compile
31 | #
32 | ifeq ($(OS),Windows_NT)
33 | # WIN32
34 | # We are under windows.
35 | ifeq ($(XTENSA_CORE),lx106)
36 | # It is xcc
37 | AR = xt-ar
38 | CC = xt-xcc
39 | LD = xt-xcc
40 | NM = xt-nm
41 | CPP = xt-cpp
42 | OBJCOPY = xt-objcopy
43 | #MAKE = xt-make
44 | CCFLAGS += -Os --rename-section .text=.irom0.text --rename-section .literal=.irom0.literal
45 | else
46 | # It is gcc, may be cygwin
47 | # Can we use -fdata-sections?
48 | CCFLAGS += -Os -ffunction-sections -fno-jump-tables
49 | AR = xtensa-lx106-elf-ar
50 | CC = xtensa-lx106-elf-gcc
51 | LD = xtensa-lx106-elf-gcc
52 | NM = xtensa-lx106-elf-nm
53 | CPP = xtensa-lx106-elf-cpp
54 | OBJCOPY = xtensa-lx106-elf-objcopy
55 | endif
56 | ESPPORT ?= com1
57 | SDK_BASE ?= c:/Espressif/ESP8266_SDK
58 | ifeq ($(PROCESSOR_ARCHITECTURE),AMD64)
59 | # ->AMD64
60 | endif
61 | ifeq ($(PROCESSOR_ARCHITECTURE),x86)
62 | # ->IA32
63 | endif
64 | else
65 | # We are under other system, may be Linux. Assume using gcc.
66 | # Can we use -fdata-sections?
67 | ESPPORT ?= /dev/ttyUSB0
68 | SDK_BASE ?= /opt/local/esp-open-sdk/sdk
69 |
70 | CCFLAGS += -Os -ffunction-sections -fno-jump-tables
71 | AR = xtensa-lx106-elf-ar
72 | CC = xtensa-lx106-elf-gcc
73 | LD = xtensa-lx106-elf-gcc
74 | NM = xtensa-lx106-elf-nm
75 | CPP = xtensa-lx106-elf-cpp
76 | OBJCOPY = xtensa-lx106-elf-objcopy
77 | UNAME_S := $(shell uname -s)
78 |
79 | ifeq ($(UNAME_S),Linux)
80 | # LINUX
81 | endif
82 | ifeq ($(UNAME_S),Darwin)
83 | # OSX
84 | endif
85 | UNAME_P := $(shell uname -p)
86 | ifeq ($(UNAME_P),x86_64)
87 | # ->AMD64
88 | endif
89 | ifneq ($(filter %86,$(UNAME_P)),)
90 | # ->IA32
91 | endif
92 | ifneq ($(filter arm%,$(UNAME_P)),)
93 | # ->ARM
94 | endif
95 | endif
96 | #############################################################
97 |
98 | EGP_BASE ?= ../dependencies/easygpio/../../../
99 | DEP_BASE ?= ../dependencies
100 |
101 | # which modules (subdirectories) of the project to include in compiling
102 | MODULES = localinclude $(EGP_BASE) $(DEP_BASE)/stdout user
103 | EXTRA_INCDIR = include $(SDK_BASE)/../include
104 |
105 | # libraries used in this project, mainly provided by the SDK
106 | LIBS = c gcc hal phy pp net80211 lwip wpa main
107 |
108 | # compiler flags using during compilation of source files
109 | CFLAGS = -Os -Wpointer-arith -Wundef -Werror -Wl,-EL -fno-inline-functions -nostdlib -mlongcalls -mtext-section-literals -D__ets__ -DICACHE_FLASH
110 |
111 | # linker flags used to generate the main object file
112 | LDFLAGS = -nostdlib -Wl,--no-check-sections -u call_user_start -Wl,-static
113 |
114 | ifeq ($(FLAVOR),debug)
115 | CFLAGS += -O0
116 | LDFLAGS += -O0
117 | endif
118 |
119 | ifeq ($(FLAVOR),release)
120 | CFLAGS += -O2
121 | LDFLAGS += -O2
122 | endif
123 |
124 |
125 |
126 | # various paths from the SDK used in this project
127 | SDK_LIBDIR = lib
128 | SDK_LDDIR = ld
129 | SDK_INCDIR = include include/json
130 |
131 | ####
132 | #### no user configurable options below here
133 | ####
134 | FW_TOOL ?= $(ESPTOOL)
135 | SRC_DIR := $(MODULES)
136 | BUILD_DIR := $(addprefix $(BUILD_BASE)/,$(subst ../,, $(MODULES)))
137 |
138 | SDK_LIBDIR := $(addprefix $(SDK_BASE)/,$(SDK_LIBDIR))
139 | SDK_INCDIR := $(addprefix -I$(SDK_BASE)/,$(SDK_INCDIR))
140 |
141 | SRC := $(foreach sdir,$(SRC_DIR),$(wildcard $(sdir)/*.c))
142 | OBJ := $(patsubst %.c,$(BUILD_BASE)/%.o,$(subst ../,, $(SRC)))
143 | LIBS := $(addprefix -l,$(LIBS))
144 | APP_AR := $(addprefix $(BUILD_BASE)/,$(TARGET)_app.a)
145 | TARGET_OUT := $(addprefix $(BUILD_BASE)/,$(TARGET).out)
146 |
147 | LD_SCRIPT := $(addprefix -T$(SDK_BASE)/$(SDK_LDDIR)/,$(LD_SCRIPT))
148 |
149 | INCDIR := $(addprefix -I,$(SRC_DIR))
150 | EXTRA_INCDIR := $(addprefix -I,$(EXTRA_INCDIR))
151 | MODULE_INCDIR := $(addsuffix /include,$(INCDIR))
152 |
153 | FW_FILE_1 := $(addprefix $(FW_BASE)/,$(FW_1).bin)
154 | FW_FILE_2 := $(addprefix $(FW_BASE)/,$(FW_2).bin)
155 |
156 | V ?= $(VERBOSE)
157 | ifeq ("$(V)","1")
158 | Q :=
159 | vecho := @true
160 | else
161 | Q := @
162 | vecho := @echo
163 | endif
164 |
165 | vpath %.c $(SRC_DIR)
166 |
167 | define compile-objects
168 | $1/%.o: %.c
169 | $(vecho) "CC $$<"
170 | $(Q) $(CC) $(INCDIR) $(MODULE_INCDIR) $(EXTRA_INCDIR) $(SDK_INCDIR) $(CFLAGS) -c $$< -o $$@
171 | endef
172 |
173 | .PHONY: all checkdirs clean
174 |
175 | all: checkdirs $(TARGET_OUT) $(FW_FILE_1) $(FW_FILE_2)
176 |
177 | $(FW_FILE_1): $(TARGET_OUT)
178 | $(vecho) "FW $@"
179 | $(ESPTOOL) elf2image $< -o $(FW_BASE)/
180 |
181 | $(FW_FILE_2): $(TARGET_OUT)
182 | $(vecho) "FW $@"
183 | $(ESPTOOL) elf2image $< -o $(FW_BASE)/
184 |
185 | $(TARGET_OUT): $(APP_AR)
186 | $(vecho) "LD $@"
187 | $(Q) $(LD) -L$(SDK_LIBDIR) $(LD_SCRIPT) $(LDFLAGS) -Wl,--start-group $(LIBS) $(APP_AR) -Wl,--end-group -o $@
188 |
189 | $(APP_AR): $(OBJ)
190 | $(vecho) "AR $@"
191 | $(Q) $(AR) cru $@ $^
192 |
193 | checkdirs: $(BUILD_DIR) $(FW_BASE)
194 |
195 | $(BUILD_DIR):
196 | $(Q) mkdir -p $@
197 |
198 | firmware:
199 | $(Q) mkdir -p $@
200 |
201 | flash: $(FW_FILE_1) $(FW_FILE_2)
202 | $(ESPTOOL) -p $(ESPPORT) write_flash $(FW_1) $(FW_FILE_1) $(FW_2) $(FW_FILE_2)
203 |
204 | test: flash
205 | screen $(ESPPORT) 115200
206 |
207 | rebuild: clean all
208 |
209 | clean:
210 | $(Q) rm -f $(APP_AR)
211 | $(Q) rm -f $(TARGET_OUT)
212 | $(Q) rm -rf $(BUILD_DIR)
213 | $(Q) rm -rf $(BUILD_BASE)
214 | $(Q) rm -f $(FW_FILE_1)
215 | $(Q) rm -f $(FW_FILE_2)
216 | $(Q) rm -rf $(FW_BASE)
217 |
218 | $(foreach bdir,$(BUILD_DIR),$(eval $(call compile-objects,$(bdir))))
219 |
--------------------------------------------------------------------------------
/driver/easygpio/examples/readgpio/include/user_config.h:
--------------------------------------------------------------------------------
1 | #ifndef __USER_CONFIG_H__
2 | #define __USER_CONFIG_H__
3 |
4 | #endif
5 |
--------------------------------------------------------------------------------
/driver/easygpio/examples/readgpio/localinclude/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eadf/esp8266_ping/e2b970d4ff52de8daf8d5dcf8d37e3ec24fd0413/driver/easygpio/examples/readgpio/localinclude/.keep
--------------------------------------------------------------------------------
/driver/easygpio/examples/readgpio/user/user_main.c:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2015, eadf (https://github.com/eadf)
3 | * All rights reserved.
4 | *
5 | * Redistribution and use in source and binary forms, with or without
6 | * modification, are permitted provided that the following conditions are met:
7 | *
8 | * * Redistributions of source code must retain the above copyright notice,
9 | * this list of conditions and the following disclaimer.
10 | * * Redistributions in binary form must reproduce the above copyright
11 | * notice, this list of conditions and the following disclaimer in the
12 | * documentation and/or other materials provided with the distribution.
13 | * * Neither the name of Redis nor the names of its contributors may be used
14 | * to endorse or promote products derived from this software without
15 | * specific prior written permission.
16 | *
17 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 | * POSSIBILITY OF SUCH DAMAGE.
28 | */
29 |
30 | #include
31 | #include
32 | #include "gpio.h"
33 | #include "easygpio/easygpio.h"
34 | #include "stdout/stdout.h"
35 |
36 | #define SAMPLE_PERIOD 750 // 750 ms
37 | static os_timer_t loop_timer;
38 | uint8_t pinsToTest[] = {0,2,3,4,5,12,13,14,15,16};
39 | uint8_t pinsToTestLen = 10;
40 |
41 | static void ICACHE_FLASH_ATTR
42 | loop(void) {
43 | uint8_t i=0;
44 | for (i=0; iAMD64
60 | endif
61 | ifeq ($(PROCESSOR_ARCHITECTURE),x86)
62 | # ->IA32
63 | endif
64 | else
65 | # We are under other system, may be Linux. Assume using gcc.
66 | # Can we use -fdata-sections?
67 | ESPPORT ?= /dev/ttyUSB0
68 | SDK_BASE ?= /opt/local/esp-open-sdk/sdk
69 |
70 | CCFLAGS += -Os -ffunction-sections -fno-jump-tables
71 | AR = xtensa-lx106-elf-ar
72 | CC = xtensa-lx106-elf-gcc
73 | LD = xtensa-lx106-elf-gcc
74 | NM = xtensa-lx106-elf-nm
75 | CPP = xtensa-lx106-elf-cpp
76 | OBJCOPY = xtensa-lx106-elf-objcopy
77 | UNAME_S := $(shell uname -s)
78 |
79 | ifeq ($(UNAME_S),Linux)
80 | # LINUX
81 | endif
82 | ifeq ($(UNAME_S),Darwin)
83 | # OSX
84 | endif
85 | UNAME_P := $(shell uname -p)
86 | ifeq ($(UNAME_P),x86_64)
87 | # ->AMD64
88 | endif
89 | ifneq ($(filter %86,$(UNAME_P)),)
90 | # ->IA32
91 | endif
92 | ifneq ($(filter arm%,$(UNAME_P)),)
93 | # ->ARM
94 | endif
95 | endif
96 | #############################################################
97 |
98 | EGP_BASE ?= ../dependencies/easygpio/../../../
99 | DEP_BASE ?= ../dependencies
100 |
101 | # which modules (subdirectories) of the project to include in compiling
102 | MODULES = localinclude $(EGP_BASE) $(DEP_BASE)/stdout user
103 | EXTRA_INCDIR = include $(SDK_BASE)/../include
104 |
105 | # libraries used in this project, mainly provided by the SDK
106 | LIBS = c gcc hal phy pp net80211 lwip wpa main
107 |
108 | # compiler flags using during compilation of source files
109 | CFLAGS = -Os -Wpointer-arith -Wundef -Werror -Wl,-EL -fno-inline-functions -nostdlib -mlongcalls -mtext-section-literals -D__ets__ -DICACHE_FLASH
110 |
111 | # linker flags used to generate the main object file
112 | LDFLAGS = -nostdlib -Wl,--no-check-sections -u call_user_start -Wl,-static
113 |
114 | ifeq ($(FLAVOR),debug)
115 | CFLAGS += -O0
116 | LDFLAGS += -O0
117 | endif
118 |
119 | ifeq ($(FLAVOR),release)
120 | CFLAGS += -O2
121 | LDFLAGS += -O2
122 | endif
123 |
124 |
125 |
126 | # various paths from the SDK used in this project
127 | SDK_LIBDIR = lib
128 | SDK_LDDIR = ld
129 | SDK_INCDIR = include include/json
130 |
131 | ####
132 | #### no user configurable options below here
133 | ####
134 | FW_TOOL ?= $(ESPTOOL)
135 | SRC_DIR := $(MODULES)
136 | BUILD_DIR := $(addprefix $(BUILD_BASE)/,$(subst ../,, $(MODULES)))
137 |
138 | SDK_LIBDIR := $(addprefix $(SDK_BASE)/,$(SDK_LIBDIR))
139 | SDK_INCDIR := $(addprefix -I$(SDK_BASE)/,$(SDK_INCDIR))
140 |
141 | SRC := $(foreach sdir,$(SRC_DIR),$(wildcard $(sdir)/*.c))
142 | OBJ := $(patsubst %.c,$(BUILD_BASE)/%.o,$(subst ../,, $(SRC)))
143 | LIBS := $(addprefix -l,$(LIBS))
144 | APP_AR := $(addprefix $(BUILD_BASE)/,$(TARGET)_app.a)
145 | TARGET_OUT := $(addprefix $(BUILD_BASE)/,$(TARGET).out)
146 |
147 | LD_SCRIPT := $(addprefix -T$(SDK_BASE)/$(SDK_LDDIR)/,$(LD_SCRIPT))
148 |
149 | INCDIR := $(addprefix -I,$(SRC_DIR))
150 | EXTRA_INCDIR := $(addprefix -I,$(EXTRA_INCDIR))
151 | MODULE_INCDIR := $(addsuffix /include,$(INCDIR))
152 |
153 | FW_FILE_1 := $(addprefix $(FW_BASE)/,$(FW_1).bin)
154 | FW_FILE_2 := $(addprefix $(FW_BASE)/,$(FW_2).bin)
155 |
156 | V ?= $(VERBOSE)
157 | ifeq ("$(V)","1")
158 | Q :=
159 | vecho := @true
160 | else
161 | Q := @
162 | vecho := @echo
163 | endif
164 |
165 | vpath %.c $(SRC_DIR)
166 |
167 | define compile-objects
168 | $1/%.o: %.c
169 | $(vecho) "CC $$<"
170 | $(Q) $(CC) $(INCDIR) $(MODULE_INCDIR) $(EXTRA_INCDIR) $(SDK_INCDIR) $(CFLAGS) -c $$< -o $$@
171 | endef
172 |
173 | .PHONY: all checkdirs clean
174 |
175 | all: checkdirs $(TARGET_OUT) $(FW_FILE_1) $(FW_FILE_2)
176 |
177 | $(FW_FILE_1): $(TARGET_OUT)
178 | $(vecho) "FW $@"
179 | $(ESPTOOL) elf2image $< -o $(FW_BASE)/
180 |
181 | $(FW_FILE_2): $(TARGET_OUT)
182 | $(vecho) "FW $@"
183 | $(ESPTOOL) elf2image $< -o $(FW_BASE)/
184 |
185 | $(TARGET_OUT): $(APP_AR)
186 | $(vecho) "LD $@"
187 | $(Q) $(LD) -L$(SDK_LIBDIR) $(LD_SCRIPT) $(LDFLAGS) -Wl,--start-group $(LIBS) $(APP_AR) -Wl,--end-group -o $@
188 |
189 | $(APP_AR): $(OBJ)
190 | $(vecho) "AR $@"
191 | $(Q) $(AR) cru $@ $^
192 |
193 | checkdirs: $(BUILD_DIR) $(FW_BASE)
194 |
195 | $(BUILD_DIR):
196 | $(Q) mkdir -p $@
197 |
198 | firmware:
199 | $(Q) mkdir -p $@
200 |
201 | flash: $(FW_FILE_1) $(FW_FILE_2)
202 | $(ESPTOOL) -p $(ESPPORT) write_flash $(FW_1) $(FW_FILE_1) $(FW_2) $(FW_FILE_2)
203 |
204 | test: flash
205 | screen $(ESPPORT) 115200
206 |
207 | rebuild: clean all
208 |
209 | clean:
210 | $(Q) rm -f $(APP_AR)
211 | $(Q) rm -f $(TARGET_OUT)
212 | $(Q) rm -rf $(BUILD_DIR)
213 | $(Q) rm -rf $(BUILD_BASE)
214 | $(Q) rm -f $(FW_FILE_1)
215 | $(Q) rm -f $(FW_FILE_2)
216 | $(Q) rm -rf $(FW_BASE)
217 |
218 | $(foreach bdir,$(BUILD_DIR),$(eval $(call compile-objects,$(bdir))))
219 |
--------------------------------------------------------------------------------
/driver/easygpio/examples/writegpio/include/user_config.h:
--------------------------------------------------------------------------------
1 | #ifndef __USER_CONFIG_H__
2 | #define __USER_CONFIG_H__
3 |
4 | #endif
5 |
--------------------------------------------------------------------------------
/driver/easygpio/examples/writegpio/localinclude/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eadf/esp8266_ping/e2b970d4ff52de8daf8d5dcf8d37e3ec24fd0413/driver/easygpio/examples/writegpio/localinclude/.keep
--------------------------------------------------------------------------------
/driver/easygpio/examples/writegpio/user/user_main.c:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2015, eadf (https://github.com/eadf)
3 | * All rights reserved.
4 | *
5 | * Redistribution and use in source and binary forms, with or without
6 | * modification, are permitted provided that the following conditions are met:
7 | *
8 | * * Redistributions of source code must retain the above copyright notice,
9 | * this list of conditions and the following disclaimer.
10 | * * Redistributions in binary form must reproduce the above copyright
11 | * notice, this list of conditions and the following disclaimer in the
12 | * documentation and/or other materials provided with the distribution.
13 | * * Neither the name of Redis nor the names of its contributors may be used
14 | * to endorse or promote products derived from this software without
15 | * specific prior written permission.
16 | *
17 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 | * POSSIBILITY OF SUCH DAMAGE.
28 | */
29 |
30 | #include
31 | #include
32 | #include "gpio.h"
33 | #include "easygpio/easygpio.h"
34 | #include "stdout/stdout.h"
35 |
36 | #define SAMPLE_PERIOD 200 // 200 ms
37 | static os_timer_t dht22_timer;
38 | uint8_t pinsToTest[] = {0,2,4,5,12,13,14,15,16};
39 | uint8_t pinsToTestLen = 9;
40 |
41 | static void ICACHE_FLASH_ATTR
42 | loop(void) {
43 | // set this shift-rotating pattern to anything you like
44 | static uint32_t shiftReg = 1;//0b101010101;
45 | uint8_t i=0;
46 | os_printf("Setting ");
47 | for (i=0; i> i) & 0x1;
49 | os_printf("GPIO%d=%d", pinsToTest[i], flag);
50 | easygpio_outputSet(pinsToTest[i], flag);
51 | //easygpio_outputEnable(pinsToTest[i], flag);
52 | if(i> 1);
62 | }
63 |
64 | void ICACHE_FLASH_ATTR
65 | setup(void) {
66 | uint8_t i=0;
67 | for (i=0; i0){
58 | gpio_pin_intr_state_set(GPIO_ID_PIN(pin), GPIO_PIN_INTR_DISABLE);
59 | }
60 | }
61 |
62 | static void
63 | ping_intr_handler(void *key) {
64 | uint32_t gpio_status = GPIO_REG_READ(GPIO_STATUS_ADDRESS);
65 | if (ping_allEchoPins & gpio_status) {
66 | if (ping_currentEchoPin>=0 && (gpio_status & BIT(ping_currentEchoPin))) {
67 | // This interrupt was intended for us - clear interrupt status
68 | GPIO_REG_WRITE(GPIO_STATUS_W1TC_ADDRESS, gpio_status & BIT(ping_currentEchoPin));
69 |
70 | if(!ping_echoStarted) {
71 | gpio_pin_intr_state_set(GPIO_ID_PIN(ping_currentEchoPin), GPIO_PIN_INTR_NEGEDGE);
72 | ping_timeStamp0 = system_get_time();
73 | ping_echoStarted = true;
74 | } else {
75 | ping_timeStamp1 = system_get_time();
76 | ping_echoEnded = true;
77 | ping_disableInterrupt(ping_currentEchoPin);
78 | ping_currentEchoPin = -1;
79 | }
80 | } else {
81 | // This interrupt was intended for us, but not at this moment - clear interrupt status anyway
82 | GPIO_REG_WRITE(GPIO_STATUS_W1TC_ADDRESS, gpio_status & ping_allEchoPins);
83 | }
84 | }
85 | }
86 |
87 | /**
88 | * Sends a ping, and returns the number of microseconds it took to receive a response.
89 | * Will give up after maxPeriod (with false as return value)
90 | */
91 | bool ICACHE_FLASH_ATTR
92 | ping_pingUs(Ping_Data *pingData, uint32_t maxPeriod, uint32_t* response) {
93 | uint32_t timeOutAt = system_get_time() + maxPeriod;
94 | ping_echoEnded = false;
95 | ping_echoStarted = false;
96 | ping_timeStamp0 = system_get_time();
97 |
98 | if (!pingData->isInitiated) {
99 | *response = 0;
100 | os_printf("ping_pingUs: Error: not initiated properly.\n");
101 | return false;
102 | }
103 | if (ping_currentEchoPin >= 0) {
104 | // this should not really happend, how did you end up here?
105 | *response = 0;
106 | os_printf("ping_pingUs: Error: another ping is already running.\n");
107 | return false;
108 | }
109 |
110 | uint32_t echoPin = pingData->echoPin;
111 | uint32_t triggerPin = pingData->triggerPin;
112 | ping_currentEchoPin = pingData->echoPin;
113 |
114 | while (GPIO_INPUT_GET(echoPin)) {
115 | if (system_get_time() > timeOutAt) {
116 | // echo pin never went low, something is wrong.
117 | // turns out this happens whenever the sensor doesn't receive any echo at all.
118 |
119 | //os_printf("ping_ping: Error: echo pin %d permanently high %d?.\n", echoPin, GPIO_INPUT_GET(echoPin));
120 | *response = system_get_time() - ping_timeStamp0;
121 |
122 | // Wake up a sleeping device
123 | GPIO_OUTPUT_SET(triggerPin, PING_TRIGGER_DEFAULT_STATE);
124 | os_delay_us(50);
125 | GPIO_OUTPUT_SET(triggerPin, !PING_TRIGGER_DEFAULT_STATE);
126 | os_delay_us(50);
127 | GPIO_OUTPUT_SET(triggerPin, PING_TRIGGER_DEFAULT_STATE);
128 | ping_disableInterrupt(ping_currentEchoPin);
129 | ping_currentEchoPin = -1;
130 | return false;
131 | }
132 | os_delay_us(PING_POLL_PERIOD);
133 | }
134 |
135 | GPIO_OUTPUT_SET(triggerPin, 1);
136 | os_delay_us(PING_TRIGGER_LENGTH);
137 | GPIO_OUTPUT_SET(triggerPin, 0);
138 |
139 | if (echoPin == triggerPin) {
140 | // force the trigger pin low for 50us. This helps stabilise echo pin when
141 | // running in single pin mode.
142 | os_delay_us(50);
143 | }
144 |
145 | GPIO_DIS_OUTPUT(echoPin);
146 | gpio_pin_intr_state_set(GPIO_ID_PIN(echoPin), GPIO_PIN_INTR_POSEDGE);
147 |
148 | while (!ping_echoEnded) {
149 | if (system_get_time() > timeOutAt) {
150 | *response = system_get_time() - ping_timeStamp0;
151 | ping_disableInterrupt(ping_currentEchoPin);
152 | ping_currentEchoPin = -1;
153 | return false;
154 | }
155 | os_delay_us(PING_POLL_PERIOD);
156 | }
157 |
158 | *response = ping_timeStamp1 - ping_timeStamp0;
159 | if (ping_timeStamp1 < ping_timeStamp0 || *response < 50) {
160 | // probably a previous echo or clock overflow - false result
161 | ping_disableInterrupt(ping_currentEchoPin);
162 | ping_currentEchoPin = -1;
163 | return false;
164 | }
165 | return true;
166 | }
167 |
168 | bool ICACHE_FLASH_ATTR
169 | ping_ping(Ping_Data *pingData, float maxDistance, float* returnDistance) {
170 | uint32_t echoTime = 0;
171 | uint32_t maxPeriod = 0;
172 |
173 | switch (pingData->unit) {
174 | case PING_MM:
175 | maxPeriod = maxDistance/PING_US_TO_MM;
176 | break;
177 | case PING_INCHES:
178 | maxPeriod = maxDistance/PING_US_TO_INCH;
179 | break;
180 | default:
181 | // Assume distance in micro-seconds
182 | maxPeriod = (float) maxDistance;
183 | }
184 | if (!ping_pingUs(pingData, maxPeriod, &echoTime)) {
185 | //os_printf("ping_ping failed: maxPeriod=%d echoTime=%d\n",maxPeriod, (int)echoTime );
186 | return false;
187 | }
188 | switch (pingData->unit) {
189 | case PING_MM:
190 | *returnDistance = ((float) echoTime)*PING_US_TO_MM;
191 | break;
192 | case PING_INCHES:
193 | *returnDistance = ((float) echoTime)*PING_US_TO_INCH;
194 | break;
195 | default:
196 | // Assume distance in micro-seconds
197 | *returnDistance = (float) echoTime;
198 | }
199 | return true;
200 | }
201 |
202 | /**
203 | * Initiates the GPIO for one-pin mode.
204 | */
205 | bool ICACHE_FLASH_ATTR
206 | ping_initOnePinMode(Ping_Data *pingData, int8_t triggerAndEchoPin, Ping_Unit unit) {
207 | return ping_init(pingData, triggerAndEchoPin, triggerAndEchoPin, unit);
208 | }
209 |
210 | /**
211 | * Initiates the Ping_Data structure and sets the GPIOs
212 | */
213 | bool ICACHE_FLASH_ATTR
214 | ping_init(Ping_Data *pingData, int8_t triggerPin, int8_t echoPin, Ping_Unit unit) {
215 | pingData->triggerPin = triggerPin;
216 | pingData->echoPin = echoPin;
217 | pingData->unit = unit;
218 | bool singlePinMode = false;
219 |
220 | if (triggerPin == echoPin) {
221 | singlePinMode = true;
222 | } else {
223 | if (!easygpio_pinMode(pingData->triggerPin, EASYGPIO_NOPULL, EASYGPIO_OUTPUT)){
224 | os_printf("ping_init: Error: failed to set pinMode on trigger pin\n");
225 | return false;
226 | }
227 | GPIO_OUTPUT_SET(pingData->triggerPin, PING_TRIGGER_DEFAULT_STATE);
228 | }
229 |
230 | if (easygpio_attachInterrupt(pingData->echoPin, EASYGPIO_NOPULL, ping_intr_handler, NULL)) {
231 | ping_allEchoPins |= BIT(pingData->echoPin);
232 | if (singlePinMode) {
233 | // easygpio_attachInterrupt() disables output, enable it again
234 | GPIO_OUTPUT_SET(pingData->triggerPin, PING_TRIGGER_DEFAULT_STATE);
235 | }
236 | os_printf("\nInitiated ping module with trigger pin=%d echo pin=%d.\n\n",pingData->triggerPin, pingData->echoPin);
237 | pingData->isInitiated = true;
238 | } else {
239 | os_printf("ping_init: Error: failed to set interrupt on echo pin %d\n", pingData->echoPin);
240 | pingData->isInitiated = false;
241 | }
242 | return pingData->isInitiated;
243 | }
244 |
--------------------------------------------------------------------------------
/driver/stdout/.gitignore:
--------------------------------------------------------------------------------
1 | # Object files
2 | *.o
3 | *.ko
4 | *.obj
5 | *.elf
6 |
7 | # Precompiled Headers
8 | *.gch
9 | *.pch
10 |
11 | # Libraries
12 | *.lib
13 | *.a
14 | *.la
15 | *.lo
16 |
17 | # Shared objects (inc. Windows DLLs)
18 | *.dll
19 | *.so
20 | *.so.*
21 | *.dylib
22 |
23 | # Executables
24 | *.exe
25 | *.out
26 | *.app
27 | *.i*86
28 | *.x86_64
29 | *.hex
30 |
--------------------------------------------------------------------------------
/driver/stdout/README.md:
--------------------------------------------------------------------------------
1 | # esp8266_stdout
2 | A clone of Jeroen Domburg's () stdout driver.
3 | It's an alternative uart driver that only uses the TX pin, so the RX pin is free for GPIO use.
4 |
5 | Needless to say, but this driver can only transmit.
6 |
7 | ###License:
8 | "THE BEER-WARE LICENSE" (Revision 42):
9 | Jeroen Domburg wrote this file. As long as you retain
10 | this notice you can do whatever you want with this stuff. If we meet some day,
11 | and you think this stuff is worth it, you can buy me a beer in return.
12 |
13 |
14 |
--------------------------------------------------------------------------------
/driver/stdout/include/stdout/stdout.h:
--------------------------------------------------------------------------------
1 | //Stupid bit of code that does the bare minimum to make os_printf work.
2 |
3 | /*
4 | * ----------------------------------------------------------------------------
5 | * "THE BEER-WARE LICENSE" (Revision 42):
6 | * Jeroen Domburg wrote this file. As long as you retain
7 | * this notice you can do whatever you want with this stuff. If we meet some day,
8 | * and you think this stuff is worth it, you can buy me a beer in return.
9 | * ----------------------------------------------------------------------------
10 | */
11 |
12 | void stdout_init(void);
13 |
--------------------------------------------------------------------------------
/driver/stdout/include/stdout/uart_hw.h:
--------------------------------------------------------------------------------
1 | //Generated at 2012-07-03 18:44:06
2 | /*
3 | * Copyright (c) 2010 - 2011 Espressif System
4 | *
5 | */
6 |
7 | #ifndef UART_REGISTER_H_INCLUDED
8 | #define UART_REGISTER_H_INCLUDED
9 | #define REG_UART_BASE( i ) (0x60000000+(i)*0xf00)
10 | //version value:32'h062000
11 |
12 | #define UART_FIFO( i ) (REG_UART_BASE( i ) + 0x0)
13 | #define UART_RXFIFO_RD_BYTE 0x000000FF
14 | #define UART_RXFIFO_RD_BYTE_S 0
15 |
16 | #define UART_INT_RAW( i ) (REG_UART_BASE( i ) + 0x4)
17 | #define UART_RXFIFO_TOUT_INT_RAW (BIT(8))
18 | #define UART_BRK_DET_INT_RAW (BIT(7))
19 | #define UART_CTS_CHG_INT_RAW (BIT(6))
20 | #define UART_DSR_CHG_INT_RAW (BIT(5))
21 | #define UART_RXFIFO_OVF_INT_RAW (BIT(4))
22 | #define UART_FRM_ERR_INT_RAW (BIT(3))
23 | #define UART_PARITY_ERR_INT_RAW (BIT(2))
24 | #define UART_TXFIFO_EMPTY_INT_RAW (BIT(1))
25 | #define UART_RXFIFO_FULL_INT_RAW (BIT(0))
26 |
27 | #define UART_INT_ST( i ) (REG_UART_BASE( i ) + 0x8)
28 | #define UART_RXFIFO_TOUT_INT_ST (BIT(8))
29 | #define UART_BRK_DET_INT_ST (BIT(7))
30 | #define UART_CTS_CHG_INT_ST (BIT(6))
31 | #define UART_DSR_CHG_INT_ST (BIT(5))
32 | #define UART_RXFIFO_OVF_INT_ST (BIT(4))
33 | #define UART_FRM_ERR_INT_ST (BIT(3))
34 | #define UART_PARITY_ERR_INT_ST (BIT(2))
35 | #define UART_TXFIFO_EMPTY_INT_ST (BIT(1))
36 | #define UART_RXFIFO_FULL_INT_ST (BIT(0))
37 |
38 | #define UART_INT_ENA( i ) (REG_UART_BASE( i ) + 0xC)
39 | #define UART_RXFIFO_TOUT_INT_ENA (BIT(8))
40 | #define UART_BRK_DET_INT_ENA (BIT(7))
41 | #define UART_CTS_CHG_INT_ENA (BIT(6))
42 | #define UART_DSR_CHG_INT_ENA (BIT(5))
43 | #define UART_RXFIFO_OVF_INT_ENA (BIT(4))
44 | #define UART_FRM_ERR_INT_ENA (BIT(3))
45 | #define UART_PARITY_ERR_INT_ENA (BIT(2))
46 | #define UART_TXFIFO_EMPTY_INT_ENA (BIT(1))
47 | #define UART_RXFIFO_FULL_INT_ENA (BIT(0))
48 |
49 | #define UART_INT_CLR( i ) (REG_UART_BASE( i ) + 0x10)
50 | #define UART_RXFIFO_TOUT_INT_CLR (BIT(8))
51 | #define UART_BRK_DET_INT_CLR (BIT(7))
52 | #define UART_CTS_CHG_INT_CLR (BIT(6))
53 | #define UART_DSR_CHG_INT_CLR (BIT(5))
54 | #define UART_RXFIFO_OVF_INT_CLR (BIT(4))
55 | #define UART_FRM_ERR_INT_CLR (BIT(3))
56 | #define UART_PARITY_ERR_INT_CLR (BIT(2))
57 | #define UART_TXFIFO_EMPTY_INT_CLR (BIT(1))
58 | #define UART_RXFIFO_FULL_INT_CLR (BIT(0))
59 |
60 | #define UART_CLKDIV( i ) (REG_UART_BASE( i ) + 0x14)
61 | #define UART_CLKDIV_CNT 0x000FFFFF
62 | #define UART_CLKDIV_S 0
63 |
64 | #define UART_AUTOBAUD( i ) (REG_UART_BASE( i ) + 0x18)
65 | #define UART_GLITCH_FILT 0x000000FF
66 | #define UART_GLITCH_FILT_S 8
67 | #define UART_AUTOBAUD_EN (BIT(0))
68 |
69 | #define UART_STATUS( i ) (REG_UART_BASE( i ) + 0x1C)
70 | #define UART_TXD (BIT(31))
71 | #define UART_RTSN (BIT(30))
72 | #define UART_DTRN (BIT(29))
73 | #define UART_TXFIFO_CNT 0x000000FF
74 | #define UART_TXFIFO_CNT_S 16
75 | #define UART_RXD (BIT(15))
76 | #define UART_CTSN (BIT(14))
77 | #define UART_DSRN (BIT(13))
78 | #define UART_RXFIFO_CNT 0x000000FF
79 | #define UART_RXFIFO_CNT_S 0
80 |
81 | #define UART_CONF0( i ) (REG_UART_BASE( i ) + 0x20)
82 | #define UART_TXFIFO_RST (BIT(18))
83 | #define UART_RXFIFO_RST (BIT(17))
84 | #define UART_IRDA_EN (BIT(16))
85 | #define UART_TX_FLOW_EN (BIT(15))
86 | #define UART_LOOPBACK (BIT(14))
87 | #define UART_IRDA_RX_INV (BIT(13))
88 | #define UART_IRDA_TX_INV (BIT(12))
89 | #define UART_IRDA_WCTL (BIT(11))
90 | #define UART_IRDA_TX_EN (BIT(10))
91 | #define UART_IRDA_DPLX (BIT(9))
92 | #define UART_TXD_BRK (BIT(8))
93 | #define UART_SW_DTR (BIT(7))
94 | #define UART_SW_RTS (BIT(6))
95 | #define UART_STOP_BIT_NUM 0x00000003
96 | #define UART_STOP_BIT_NUM_S 4
97 | #define UART_BIT_NUM 0x00000003
98 | #define UART_BIT_NUM_S 2
99 | #define UART_PARITY_EN (BIT(1))
100 | #define UART_PARITY (BIT(0))
101 |
102 | #define UART_CONF1( i ) (REG_UART_BASE( i ) + 0x24)
103 | #define UART_RX_TOUT_EN (BIT(31))
104 | #define UART_RX_TOUT_THRHD 0x0000007F
105 | #define UART_RX_TOUT_THRHD_S 24
106 | #define UART_RX_FLOW_EN (BIT(23))
107 | #define UART_RX_FLOW_THRHD 0x0000007F
108 | #define UART_RX_FLOW_THRHD_S 16
109 | #define UART_TXFIFO_EMPTY_THRHD 0x0000007F
110 | #define UART_TXFIFO_EMPTY_THRHD_S 8
111 | #define UART_RXFIFO_FULL_THRHD 0x0000007F
112 | #define UART_RXFIFO_FULL_THRHD_S 0
113 |
114 | #define UART_LOWPULSE( i ) (REG_UART_BASE( i ) + 0x28)
115 | #define UART_LOWPULSE_MIN_CNT 0x000FFFFF
116 | #define UART_LOWPULSE_MIN_CNT_S 0
117 |
118 | #define UART_HIGHPULSE( i ) (REG_UART_BASE( i ) + 0x2C)
119 | #define UART_HIGHPULSE_MIN_CNT 0x000FFFFF
120 | #define UART_HIGHPULSE_MIN_CNT_S 0
121 |
122 | #define UART_PULSE_NUM( i ) (REG_UART_BASE( i ) + 0x30)
123 | #define UART_PULSE_NUM_CNT 0x0003FF
124 | #define UART_PULSE_NUM_CNT_S 0
125 |
126 | #define UART_DATE( i ) (REG_UART_BASE( i ) + 0x78)
127 | #define UART_ID( i ) (REG_UART_BASE( i ) + 0x7C)
128 | #endif // UART_REGISTER_H_INCLUDED
129 |
130 | #define RX_BUFF_SIZE 256
131 | #define TX_BUFF_SIZE 100
132 | #define UART0 0
133 | #define UART1 1
134 |
135 | typedef enum {
136 | FIVE_BITS = 0x0,
137 | SIX_BITS = 0x1,
138 | SEVEN_BITS = 0x2,
139 | EIGHT_BITS = 0x3
140 | } UartBitsNum4Char;
141 |
142 | typedef enum {
143 | ONE_STOP_BIT = 0,
144 | ONE_HALF_STOP_BIT = BIT2,
145 | TWO_STOP_BIT = BIT2
146 | } UartStopBitsNum;
147 |
148 | typedef enum {
149 | NONE_BITS = 0,
150 | ODD_BITS = 0,
151 | EVEN_BITS = BIT4
152 | } UartParityMode;
153 |
154 | typedef enum {
155 | STICK_PARITY_DIS = 0,
156 | STICK_PARITY_EN = BIT3 | BIT5
157 | } UartExistParity;
158 |
159 | typedef enum {
160 | BIT_RATE_9600 = 9600,
161 | BIT_RATE_19200 = 19200,
162 | BIT_RATE_38400 = 38400,
163 | BIT_RATE_57600 = 57600,
164 | BIT_RATE_74880 = 74880,
165 | BIT_RATE_115200 = 115200,
166 | BIT_RATE_230400 = 230400,
167 | BIT_RATE_460800 = 460800,
168 | BIT_RATE_921600 = 921600
169 | } UartBautRate;
170 |
171 | typedef enum {
172 | NONE_CTRL,
173 | HARDWARE_CTRL,
174 | XON_XOFF_CTRL
175 | } UartFlowCtrl;
176 |
177 | typedef enum {
178 | EMPTY,
179 | UNDER_WRITE,
180 | WRITE_OVER
181 | } RcvMsgBuffState;
182 |
183 | typedef struct {
184 | uint32 TrxBuffSize;
185 | uint8 *pTrxBuff;
186 | } TrxMsgBuff;
187 |
188 | typedef enum {
189 | BAUD_RATE_DET,
190 | WAIT_SYNC_FRM,
191 | SRCH_MSG_HEAD,
192 | RCV_MSG_BODY,
193 | RCV_ESC_CHAR,
194 | } RcvMsgState;
195 |
196 |
--------------------------------------------------------------------------------
/driver/stdout/stdout.c:
--------------------------------------------------------------------------------
1 | //Stupid bit of code that does the bare minimum to make os_printf work.
2 |
3 | /*
4 | * ----------------------------------------------------------------------------
5 | * "THE BEER-WARE LICENSE" (Revision 42):
6 | * Jeroen Domburg wrote this file. As long as you retain
7 | * this notice you can do whatever you want with this stuff. If we meet some day,
8 | * and you think this stuff is worth it, you can buy me a beer in return.
9 | * ----------------------------------------------------------------------------
10 | */
11 | #include "stdout/stdout.h"
12 | #include "ets_sys.h"
13 | #include "osapi.h"
14 | #include "stdout/uart_hw.h"
15 |
16 | static void ICACHE_FLASH_ATTR stdoutUartTxd(char c) {
17 | //Wait until there is room in the FIFO
18 | while (((READ_PERI_REG(UART_STATUS(0))>>UART_TXFIFO_CNT_S)&UART_TXFIFO_CNT)>=126) ;
19 | //Send the character
20 | WRITE_PERI_REG(UART_FIFO(0), c);
21 | }
22 |
23 | static void ICACHE_FLASH_ATTR stdoutPutchar(char c) {
24 | //convert \n -> \r\n
25 | if (c=='\n') stdoutUartTxd('\r');
26 | stdoutUartTxd(c);
27 | }
28 |
29 |
30 | void ICACHE_FLASH_ATTR
31 | stdout_init() {
32 | //Enable TxD pin
33 | PIN_PULLUP_DIS(PERIPHS_IO_MUX_U0TXD_U);
34 | PIN_FUNC_SELECT(PERIPHS_IO_MUX_U0TXD_U, FUNC_U0TXD);
35 |
36 | //Set baud rate and other serial parameters to 115200,n,8,1
37 | uart_div_modify(0, UART_CLK_FREQ/BIT_RATE_115200);
38 | WRITE_PERI_REG(UART_CONF0(0), (STICK_PARITY_DIS)|(ONE_STOP_BIT << UART_STOP_BIT_NUM_S)| \
39 | (EIGHT_BITS << UART_BIT_NUM_S));
40 |
41 | //Reset tx & rx fifo
42 | SET_PERI_REG_MASK(UART_CONF0(0), UART_RXFIFO_RST|UART_TXFIFO_RST);
43 | CLEAR_PERI_REG_MASK(UART_CONF0(0), UART_RXFIFO_RST|UART_TXFIFO_RST);
44 | //Clear pending interrupts
45 | WRITE_PERI_REG(UART_INT_CLR(0), 0xffff);
46 |
47 | //Install our own putchar handler
48 | os_install_putc1((void *)stdoutPutchar);
49 | }
50 |
--------------------------------------------------------------------------------
/include/user_config.h:
--------------------------------------------------------------------------------
1 | #ifndef _USER_CONFIG_H_
2 | #define _USER_CONFIG_H_
3 |
4 | #define PING_SAMPLE_PERIOD 250 // 250 ms between each sample. you could go faster if you like
5 |
6 | #endif
7 |
--------------------------------------------------------------------------------
/user/user_main.c:
--------------------------------------------------------------------------------
1 | #include "ping/ping.h"
2 | #include "ets_sys.h"
3 | #include "osapi.h"
4 | #include "gpio.h"
5 | #include "os_type.h"
6 | #include "user_config.h"
7 | #include "user_interface.h"
8 | #include "stdout/stdout.h"
9 |
10 | static volatile os_timer_t loop_timer;
11 |
12 | // forward declarations
13 | void user_init(void);
14 | void loop(void);
15 | static void setup(void);
16 | static Ping_Data pingA;
17 | static Ping_Data pingB;
18 |
19 | /**
20 | * This is the main user program loop
21 | */
22 | void ICACHE_FLASH_ATTR
23 | loop(void) {
24 | float distance = 0;
25 | float maxDistance = 3000; // 3 meter
26 | if (ping_ping(&pingA, maxDistance, &distance) ) {
27 | os_printf("A Response ~ %d mm \n", (int)distance);
28 | } else {
29 | os_printf("Failed to get any response from sensor A. Is maxDistance set too low?\n");
30 | }
31 | if (ping_ping(&pingB, maxDistance, &distance) ) {
32 | os_printf("B Response ~ %d mm \n", (int)distance);
33 | } else {
34 | os_printf("Failed to get any response from sensor B. Is maxDistance set too low?\n");
35 | }
36 | }
37 |
38 | /**
39 | * Setup program. When user_init runs the debug printouts will not always
40 | * show on the serial console. So i run the inits in here, 2 seconds later.
41 | */
42 | static void ICACHE_FLASH_ATTR
43 | setup(void) {
44 | ping_init(&pingA, 2, 0, PING_MM); // trigger=GPIO2, echo=GPIO0, set the pins to the same value for one-pin-mode
45 | ping_init(&pingB, 4, 5, PING_MM); // trigger=GPIO4, echo=GPIO5, set the pins to the same value for one-pin-mode
46 |
47 | // Start repeating loop timer
48 | os_timer_disarm(&loop_timer);
49 | os_timer_setfn(&loop_timer, (os_timer_func_t *) loop, NULL);
50 | os_timer_arm(&loop_timer, PING_SAMPLE_PERIOD, true);
51 | }
52 |
53 | //Init function
54 | void ICACHE_FLASH_ATTR
55 | user_init(void) {
56 | // Make uart0 work with just the TX pin. Baud:115200,n,8,1
57 | // The RX pin is now free for GPIO use.
58 | stdout_init();
59 |
60 | // turn off WiFi for this console only demo
61 | wifi_station_set_auto_connect(false);
62 | wifi_station_disconnect();
63 |
64 | // Start setup timer
65 | os_timer_disarm(&loop_timer);
66 | os_timer_setfn(&loop_timer, (os_timer_func_t *) setup, NULL);
67 | os_timer_arm(&loop_timer, 2000, false);
68 |
69 | }
70 |
--------------------------------------------------------------------------------