├── .gitignore
├── LICENSE
├── LT8920.cpp
├── LT8920.h
├── README.md
└── examples
├── RxDemo
└── RxDemo.ino
├── TxDemo
└── TxDemo.ino
├── lt8920test
└── lt8920test.ino
└── scanner
└── scanner.ino
/.gitignore:
--------------------------------------------------------------------------------
1 | # Prerequisites
2 | *.d
3 |
4 | # Compiled Object files
5 | *.slo
6 | *.lo
7 | *.o
8 | *.obj
9 |
10 | # Precompiled Headers
11 | *.gch
12 | *.pch
13 |
14 | # Compiled Dynamic libraries
15 | *.so
16 | *.dylib
17 | *.dll
18 |
19 | # Fortran module files
20 | *.mod
21 | *.smod
22 |
23 | # Compiled Static libraries
24 | *.lai
25 | *.la
26 | *.a
27 | *.lib
28 |
29 | # Executables
30 | *.exe
31 | *.out
32 | *.app
33 |
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------
/LT8920.cpp:
--------------------------------------------------------------------------------
1 | #include
2 | #include "LT8920.h"
3 |
4 | #define REGISTER_READ 0b10000000 //bin
5 | #define REGISTER_WRITE 0b00000000 //bin
6 | #define REGISTER_MASK 0b01111111 //bin
7 |
8 | #define R_CHANNEL 7
9 | #define CHANNEL_RX_BIT 7
10 | #define CHANNEL_TX_BIT 8
11 | #define CHANNEL_MASK 0b01111111 ///bin
12 | #define DEFAULT_CHANNEL 0x31
13 |
14 | #define R_CURRENT 9
15 | #define CURRENT_POWER_SHIFT 12
16 | #define CURRENT_POWER_MASK 0b1111000000000000
17 | #define CURRENT_GAIN_SHIFT 7
18 | #define CURRENT_GAIN_MASK 0b0000011110000000
19 |
20 | #define R_DATARATE 44
21 | #define DATARATE_MASK 0xFF00
22 | #define DATARATE_1MBPS 0x0101
23 | #define DATARATE_250KBPS 0x0401
24 | #define DATARATE_125KBPS 0x0801
25 | #define DATARATE_62KBPS 0x1001
26 |
27 | #define R_SYNCWORD1 36
28 | #define R_SYNCWORD2 37
29 | #define R_SYNCWORD3 38
30 | #define R_SYNCWORD4 39
31 |
32 | #define R_PACKETCONFIG 41
33 | #define PACKETCONFIG_CRC_ON 0x8000
34 | #define PACKETCONFIG_SCRAMBLE_ON 0x4000
35 | #define PACKETCONFIG_PACK_LEN_ENABLE 0x2000
36 | #define PACKETCONFIG_FW_TERM_TX 0x1000
37 | #define PACKETCONFIG_AUTO_ACK 0x0800
38 | #define PACKETCONFIG_PKT_FIFO_POLARITY 0x0400
39 |
40 | #define R_STATUS 48
41 | #define STATUS_CRC_BIT 15
42 |
43 |
44 | #define R_FIFO 50
45 | #define R_FIFO_CONTROL 52
46 |
47 | void LT8920::dump_register(uint8_t reg) {
48 | uint16_t r = readRegister(reg);
49 | Serial.print("reg: ");
50 | Serial.print(reg);
51 | Serial.print(" , value: ");
52 | Serial.println(r,HEX);
53 | }
54 |
55 | LT8920::LT8920(const uint8_t cs, const uint8_t pkt, const uint8_t rst)
56 | {
57 | _pin_chipselect = cs;
58 | _pin_pktflag = pkt;
59 | _pin_reset = rst;
60 | _channel = DEFAULT_CHANNEL;
61 |
62 | pinMode(_pin_chipselect, OUTPUT);
63 | pinMode(_pin_pktflag, INPUT);
64 | pinMode(_pin_reset, OUTPUT);
65 |
66 | digitalWrite(_pin_chipselect, HIGH);
67 | }
68 |
69 | void LT8920::begin()
70 | {
71 | if(_pin_reset > 0)
72 | {
73 | digitalWrite(_pin_reset, LOW);
74 | delay(200);
75 | digitalWrite(_pin_reset, HIGH);
76 | delay(200);
77 |
78 | }
79 | //setup
80 |
81 | writeRegister(0, 0x6fe0);
82 | writeRegister(1, 0x5681);
83 | writeRegister(2, 0x6617);
84 | writeRegister(4, 0x9cc9); //why does this differ from powerup (5447)
85 | writeRegister(5, 0x6637); //why does this differ from powerup (f000)
86 | writeRegister(8, 0x6c90); //power (default 71af) UNDOCUMENTED
87 |
88 | setCurrentControl(4, 0); // power & gain.
89 |
90 | writeRegister(10, 0x7ffd); //bit 0: XTAL OSC enable
91 | writeRegister(11, 0x0000); //bit 8: Power down RSSI (0= RSSI operates normal)
92 | writeRegister(12, 0x0000);
93 | writeRegister(13, 0x48bd); //(default 4855)
94 |
95 | writeRegister(22, 0x00ff);
96 | writeRegister(23, 0x8005); //bit 2: Calibrate VCO before each Rx/Tx enable
97 | writeRegister(24, 0x0067);
98 | writeRegister(25, 0x1659);
99 | writeRegister(26, 0x19e0);
100 | writeRegister(27, 0x1300); //bits 5:0, Crystal Frequency adjust
101 | writeRegister(28, 0x1800);
102 |
103 | //fedcba9876543210
104 | writeRegister(32, 0x5000); //AAABBCCCDDEEFFFG A preamble length, B, syncword length, c trailer length, d packet type
105 | // E FEC_type, F BRCLK_SEL, G reserved
106 | //0x5000 = 0101 0000 0000 0000 = preamble 010 (3 bytes), B 10 (48 bits)
107 | writeRegister(33, 0x3fc7);
108 | writeRegister(34, 0x2000); //
109 | writeRegister(35, 0x0300); //POWER mode, bit 8/9 on = retransmit = 3x (default)
110 | setSyncWord(0x03805a5a03800380);
111 |
112 | writeRegister(40, 0x4401); //max allowed error bits = 0 (01 = 0 error bits)
113 | writeRegister(R_PACKETCONFIG,
114 | PACKETCONFIG_CRC_ON |
115 | PACKETCONFIG_PACK_LEN_ENABLE |
116 | PACKETCONFIG_FW_TERM_TX
117 | );
118 |
119 | writeRegister(42, 0xfdb0);
120 | writeRegister(43, 0x000f);
121 |
122 | //setDataRate(LT8920_1MBPS);
123 |
124 | writeRegister(R_FIFO, 0x0000); //TXRX_FIFO_REG (FIFO queue)
125 |
126 | writeRegister(R_FIFO_CONTROL, 0x8080); //Fifo Rx/Tx queue reset
127 |
128 | delay(200);
129 | writeRegister(R_CHANNEL, _BV(CHANNEL_TX_BIT)); //set TX mode. (TX = bit 8, RX = bit 7, so RX would be 0x0080)
130 | delay(2);
131 | writeRegister(R_CHANNEL, _channel); // Frequency = 2402 + channel
132 | }
133 |
134 | void LT8920::setChannel(uint8_t channel)
135 | {
136 | _channel = channel;
137 | writeRegister(R_CHANNEL, (_channel & CHANNEL_MASK));
138 | }
139 |
140 | uint8_t LT8920::getChannel()
141 | {
142 | return _channel;
143 | }
144 |
145 | void LT8920::setCurrentControl(uint8_t power, uint8_t gain)
146 | {
147 | writeRegister(R_CURRENT,
148 | ((power << CURRENT_POWER_SHIFT) & CURRENT_POWER_MASK) |
149 | ((gain << CURRENT_GAIN_SHIFT) & CURRENT_GAIN_MASK));
150 | }
151 |
152 | bool LT8920::setDataRate(DataRate rate)
153 | {
154 | uint16_t newValue;
155 |
156 | switch (rate)
157 | {
158 | case LT8920_1MBPS:
159 | newValue = DATARATE_1MBPS;
160 | break;
161 | case LT8920_250KBPS:
162 | newValue = DATARATE_250KBPS;
163 | break;
164 | case LT8920_125KBPS:
165 | newValue = DATARATE_125KBPS;
166 | break;
167 | case LT8920_62KBPS:
168 | newValue = DATARATE_62KBPS;
169 | break;
170 | default:
171 | return false;
172 | }
173 |
174 | writeRegister(R_DATARATE, newValue);
175 | return ( (readRegister(R_DATARATE) & DATARATE_MASK) == (newValue & DATARATE_MASK));
176 | }
177 |
178 | LT8920::DataRate LT8920::getDataRate()
179 | {
180 | uint16_t value = readRegister(R_DATARATE) & DATARATE_MASK;
181 | switch (value)
182 | {
183 | case DATARATE_1MBPS:
184 | return LT8920_1MBPS;
185 | case DATARATE_250KBPS:
186 | return LT8920_250KBPS;
187 | case DATARATE_125KBPS:
188 | return LT8920_125KBPS;
189 | case DATARATE_62KBPS:
190 | return LT8920_62KBPS;
191 | }
192 | }
193 |
194 | uint16_t LT8920::readRegister(uint8_t reg)
195 | {
196 | digitalWrite(_pin_chipselect, LOW);
197 | SPI.transfer(REGISTER_READ | (REGISTER_MASK & reg));
198 | uint8_t high = SPI.transfer(0x00);
199 | uint8_t low = SPI.transfer(0x00);
200 |
201 | digitalWrite(_pin_chipselect, HIGH);
202 |
203 | // Serial.print(reg);
204 | // Serial.print(" = ");
205 | // Serial.println(high << 8 | low);
206 |
207 | return (high << 8 | low);
208 | }
209 |
210 | uint8_t LT8920::writeRegister(uint8_t reg, uint16_t data)
211 | {
212 | uint8_t high = data >> 8;
213 | uint8_t low = data & 0xFF;
214 |
215 | return writeRegister2(reg, high, low);
216 | }
217 |
218 | uint8_t LT8920::writeRegister2(uint8_t reg, uint8_t high, uint8_t low)
219 | {
220 |
221 | // char sbuf[32];
222 | // sprintf_P(sbuf, PSTR("%d => %02x%02x"), reg, high, low);
223 | // Serial.println(sbuf);
224 |
225 |
226 | digitalWrite(_pin_chipselect, LOW);
227 | uint8_t result = SPI.transfer(REGISTER_WRITE | (REGISTER_MASK & reg));
228 | SPI.transfer(high);
229 | SPI.transfer(low);
230 |
231 | digitalWrite(_pin_chipselect, HIGH);
232 | return result;
233 | }
234 |
235 | void LT8920::sleep()
236 | {
237 | //set bit 14 on register 35.
238 | writeRegister(35, readRegister(35) | _BV(14));
239 | }
240 |
241 | void LT8920::whatsUp(Stream &stream)
242 | {
243 | uint16_t mode = readRegister(R_CHANNEL);
244 | stream.print("\nTx_EN=");
245 | stream.println((mode & _BV(CHANNEL_TX_BIT)) != false);
246 | stream.print("Rx_EN=");
247 | stream.println((mode & _BV(CHANNEL_RX_BIT)) != false);
248 | stream.print("Channel=");
249 | stream.println(mode & CHANNEL_MASK);
250 |
251 | //read the status register.
252 | uint16_t state = readRegister(R_STATUS);
253 |
254 | bool crc_error = state & _BV(15);
255 | bool fec23_error = state & _BV(14);
256 | uint8_t framer_st = (state & 0b0011111100000000) >> 8;
257 | bool pkt_flag = state & _BV(6);
258 | bool fifo_flag = state & _BV(5);
259 |
260 | stream.print("CRC=");
261 | stream.println(crc_error);
262 | stream.print("FEC=");
263 | stream.println(fec23_error);
264 | stream.print("FRAMER_ST=");
265 | stream.println(framer_st);
266 | stream.print("PKT=");
267 | stream.println(pkt_flag);
268 | stream.print("FIFO=");
269 | stream.println(fifo_flag);
270 |
271 | uint16_t fifo = readRegister(R_FIFO_CONTROL);
272 | stream.print("FIFO_WR_PTR=");
273 | stream.println((fifo >> 8) & 0b111111);
274 | stream.print("FIFO_RD_PTR=");
275 | stream.println(fifo & 0b111111);
276 | }
277 |
278 | bool LT8920::available()
279 | {
280 | //read the PKT_FLAG state; this can also be done with a hard wire.
281 |
282 | if (digitalRead(_pin_pktflag) != 0)
283 | {
284 | return true;
285 | }
286 |
287 | return false;
288 | }
289 |
290 | int LT8920::read(uint8_t *buffer, size_t maxBuffer)
291 | {
292 | uint16_t value = readRegister(R_STATUS);
293 | if (bitRead(value, STATUS_CRC_BIT) == 0)
294 | {
295 | //CRC ok
296 |
297 | uint16_t data = readRegister(R_FIFO);
298 | uint8_t packetSize = data >> 8;
299 | if(maxBuffer < packetSize+1)
300 | {
301 | //BUFFER TOO SMALL
302 | return -2;
303 | }
304 |
305 | uint8_t pos;
306 | buffer[pos++] = (data & 0xFF);
307 | while (pos < packetSize)
308 | {
309 | data = readRegister(R_FIFO);
310 | buffer[pos++] = data >> 8;
311 | buffer[pos++] = data & 0xFF;
312 | }
313 |
314 | return packetSize;
315 | }
316 | else
317 | {
318 | //CRC error
319 | return -1;
320 | }
321 | }
322 |
323 | void LT8920::startListening()
324 | {
325 | writeRegister(R_CHANNEL, _channel & CHANNEL_MASK); //turn off rx/tx
326 | delay(3);
327 | writeRegister(R_FIFO_CONTROL, 0x0080); //flush rx
328 | writeRegister(R_CHANNEL, (_channel & CHANNEL_MASK) | _BV(CHANNEL_RX_BIT)); //enable RX
329 | delay(5);
330 | }
331 |
332 | /* set the BRCLK_SEL value */
333 | void LT8920::setClock(uint8_t clock)
334 | {
335 | //register 32, bits 3:1.
336 | uint16_t val = readRegister(35);
337 | val &= 0b1111111111110001;
338 | val |= ((clock & 0x07) << 1);;
339 |
340 | writeRegister(35, val);
341 | }
342 |
343 | bool LT8920::sendPacket(uint8_t *data, size_t packetSize)
344 | {
345 | if (packetSize < 1 || packetSize > 255)
346 | {
347 | return false;
348 | }
349 |
350 | writeRegister(R_CHANNEL, 0x0000);
351 | writeRegister(R_FIFO_CONTROL, 0x8000); //flush tx
352 |
353 | //packets are sent in 16bit words, and the first word will be the packet size.
354 | //start spitting out words until we are done.
355 |
356 | uint8_t pos = 0;
357 | writeRegister2(R_FIFO, packetSize, data[pos++]);
358 | while (pos < packetSize)
359 | {
360 | uint8_t msb = data[pos++];
361 | uint8_t lsb = data[pos++];
362 |
363 | writeRegister2(R_FIFO, msb, lsb);
364 | }
365 |
366 | writeRegister(R_CHANNEL, (_channel & CHANNEL_MASK) | _BV(CHANNEL_TX_BIT)); //enable TX
367 |
368 | //Wait until the packet is sent.
369 | while (digitalRead(_pin_pktflag) == 0)
370 | {
371 | //do nothing.
372 | }
373 |
374 | return true;
375 | }
376 |
377 | void LT8920::setSyncWord(uint64_t syncWord)
378 | {
379 | writeRegister(R_SYNCWORD1, syncWord);
380 | writeRegister(R_SYNCWORD2, syncWord >> 16);
381 | writeRegister(R_SYNCWORD3, syncWord >> 32);
382 | writeRegister(R_SYNCWORD4, syncWord >> 48);
383 | }
384 |
385 | void LT8920::setSyncWordLength(uint8_t option)
386 | {
387 | option &= 0x03;
388 | option <<= 11;
389 |
390 | writeRegister(32, (readRegister(32) & 0b0001100000000000) | option);
391 | }
392 |
393 | uint8_t LT8920::getRSSI()
394 | {
395 | //RSSI: 15:10
396 | uint16_t value = readRegister(6);
397 |
398 | return (value >> 10);
399 | }
400 |
401 | void LT8920::scanRSSI(uint16_t *buffer, uint8_t start_channel, uint8_t num_channels)
402 | {
403 | // writeRegister(R_CHANNEL, _BV(CHANNEL_RX_BIT));
404 | //
405 | // //add read mode.
406 | writeRegister(R_FIFO_CONTROL, 0x8080); //flush rx
407 | // writeRegister(R_CHANNEL, 0x0000);
408 |
409 | //set number of channels to scan.
410 | writeRegister(42, (readRegister(42) & 0b0000001111111111) | ((num_channels-1 & 0b111111) << 10));
411 |
412 | //set channel scan offset.
413 | writeRegister(43, (readRegister(43) & 0b0000000011111111) | ((start_channel & 0b1111111) << 8));
414 | writeRegister(43, (readRegister(43) & 0b0111111111111111) | _BV(15));
415 |
416 | while(digitalRead(_pin_pktflag) == 0)
417 | {
418 | }
419 |
420 |
421 | //read the results.
422 | uint8_t pos = 0;
423 | while(pos < num_channels)
424 | {
425 | uint16_t data = readRegister(R_FIFO);
426 | buffer[pos++] = data >> 8;
427 | }
428 | }
429 |
--------------------------------------------------------------------------------
/LT8920.h:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright (C) 2015 Rob van der Veer,
3 |
4 | This program is free software; you can redistribute it and/or
5 | modify it under the terms of the GNU General Public License
6 | version 2 as published by the Free Software Foundation.
7 | */
8 |
9 | #ifndef LT8920_H
10 | #define LT8920_H
11 |
12 | class LT8920
13 | {
14 |
15 | public:
16 | /** Data Data
17 | */
18 | enum DataRate
19 | {
20 | LT8920_1MBPS, /** default transmit rate */
21 | LT8920_250KBPS, /** 250 Kpbs, only on lt8910 */
22 | LT8920_125KBPS, /** 125 Kbps, only on lt8910 */
23 | LT8920_62KBPS /** 62 Kbps, only on lt8910 */
24 | };
25 |
26 | private:
27 | uint8_t _pin_chipselect;
28 | uint8_t _pin_pktflag;
29 | uint8_t _pin_reset;
30 | uint8_t _channel;
31 |
32 | public:
33 | /** Construct a new instance
34 | * @param cs Chip Select, this is the SLAVE SELECT pin. Please note that it is a different location than the NRF24L01+ SS pin.
35 | * @param pkt PKT_flag input signal pin. Comparable to the NRF24L01+ IRQ pin.
36 | * @param rst RESET pin. Use 0 to disable.
37 | */
38 | LT8920(const uint8_t cs, const uint8_t pkt, const uint8_t rst);
39 |
40 | /** Configures the module for initial use */
41 | void begin();
42 |
43 | /** 设置信道
44 | * @param channel has significant 7 bits
45 | */
46 | void setChannel(uint8_t channel);
47 | /** Retrieve the current channel */
48 | uint8_t getChannel();
49 |
50 | /** Set power and gain
51 | * @param power 0-0xf
52 | * @param gain 0-0xf
53 | */
54 | void setCurrentControl(uint8_t power, uint8_t gain);
55 |
56 | /** Sets the data rate
57 | * @param rate the transmission/reception speed
58 | * @returns true when the data rate was succesfully changed.
59 | */
60 | bool setDataRate(DataRate rate);
61 |
62 | /** Returns the data rate
63 | * @returns the active data rate.
64 | */
65 | DataRate getDataRate();
66 |
67 | /** Read the value of a register
68 | * @param reg
69 | */
70 | uint16_t readRegister(uint8_t reg);
71 |
72 | /** Writes to a register
73 | * @param reg The register to write to
74 | * @param data 16bits of data, MSB first */
75 | uint8_t writeRegister(uint8_t reg, uint16_t data);
76 |
77 | /** Writes to a register, one byte at a time.
78 | * This is a convenience function, because the LT8920 uses 16 bits registers with all 16 bits written at once.
79 | * @param reg The register to write to
80 | * @param high bits 15..8
81 | * @param low bits 7..0 */
82 | uint8_t writeRegister2(uint8_t reg, uint8_t high, uint8_t low);
83 |
84 | void dump_register(uint8_t reg);
85 |
86 | /** Put the LT8920 module to sleep mode.
87 | * In contrast to POWER DOWN, this mode will keep the register values
88 | * Any SPI call will awaken the module automatically */
89 | void sleep();
90 |
91 | /** Dumps debug information on the selected port
92 | * @param stream the output stream to use as output, eg. `whatsUp(&Serial);`
93 | */
94 | void whatsUp(Stream &stream);
95 |
96 | /** Signals a packet ready in the FIFO queue */
97 | bool available();
98 |
99 | /** Read a packet into the buffer
100 | * @param buffer a pointer to a buffer large enough to hold the packet
101 | * @param maxBuffer the maximum size of the buffer. Any bytes left over in the buffer will be dropped.
102 | * @returns the size of the packet that was read, -1 for CRC error
103 | */
104 | int read(uint8_t *buffer, size_t maxBuffer);
105 |
106 | /** Switch the module to RX mode */
107 | void startListening();
108 |
109 | /** Sets the internal clock divider
110 | * @param clock
111 | */
112 | void setClock(uint8_t clock);
113 |
114 | /** Sends a packet
115 | * This call blocks until the packet was sent and the Tx Buffer has been completed
116 | * @param data
117 | * @param packetSize
118 | * @returns true when the packet was sent, or false when the packetSize was invalid.
119 | */
120 | bool sendPacket(uint8_t *data, size_t packetSize);
121 |
122 | /** Set Syncword
123 | * @param syncWord 64 bits of sync word settings.
124 | * @see setSyncwordLength
125 | */
126 | void setSyncWord(uint64_t syncWord);
127 |
128 | /** Sets the length of the sync word used
129 | * @param length:
130 | * 11 = 64bits, 10 = 48 bits, 01 = 32 bits, 00 = 16 bits
131 | * @see Check the datasheet for which bits are actually used.
132 | */
133 | void setSyncWordLength(uint8_t length);
134 |
135 | /** Scan the signal strength for one or more channels
136 | * @param buffer points to a buffer to store the signal strengths, at least num_channels
137 | * @param start_channel starting channel to scan, where Frequency = 2402 + channel
138 | * @param num_channels number of channels to scan in this batch, for example scanning 4 channels
139 | * with start 2480 will scan 2480, 2481, 2482, 2483
140 | */
141 | void scanRSSI(uint16_t *buffer, uint8_t start_channel, uint8_t num_channels);
142 |
143 | /** retrieve the analog signal strength for the current channel */
144 | uint8_t getRSSI();
145 | };
146 |
147 |
148 | #endif //LT8920_H
149 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # LT8920
2 | Arduino Library for LT8920 2.4G RF Transceiver
3 | This project is based on LT8910 Project: https://github.com/534659123/LT8910
4 | Change List:
5 | 1. fix some small bugs.
6 | 2. works on ESP8266 Arduino.
7 | 3. clean some notes.
8 | 4. add dump_register method for debug.
9 | 5. remove some useless files.
10 |
11 | Note: Data rate may have issues when setting other value than 1Mbps.
12 |
--------------------------------------------------------------------------------
/examples/RxDemo/RxDemo.ino:
--------------------------------------------------------------------------------
1 | #include
2 | #include "LT8920.h"
3 |
4 | const uint8_t PIN_NRF_RST = 16;
5 | const uint8_t PIN_NRF_CS = 5;
6 | const uint8_t PIN_NRF_PKT = 4;
7 |
8 |
9 | LT8920 lt(PIN_NRF_CS, PIN_NRF_PKT, PIN_NRF_RST);
10 |
11 | void setup()
12 | {
13 | Serial.begin(74880);
14 | SPI.begin();
15 | SPI.setBitOrder(MSBFIRST);
16 | SPI.setClockDivider(SPI_CLOCK_DIV64);
17 | delay(500);
18 | lt.begin();
19 | lt.setCurrentControl(0,0);
20 | lt.setDataRate(LT8920::LT8920_1MBPS);
21 | lt.setChannel(0x20);
22 | }
23 |
24 | void loop()
25 | {
26 | if (lt.available())
27 | {
28 | uint8_t data[16];
29 | int packetSize = lt.read(data, 16);
30 | if (packetSize > 0)
31 | {
32 | Serial.println(F("Packet read OK"));
33 | Serial.println((char *)data);
34 | }
35 | else
36 | {
37 | Serial.println(F("CRC is ERROR"));
38 | }
39 | lt.startListening();
40 | }
41 | }
--------------------------------------------------------------------------------
/examples/TxDemo/TxDemo.ino:
--------------------------------------------------------------------------------
1 | #include
2 | #include "LT8920.h"
3 |
4 | const uint8_t PIN_NRF_RST = 16;
5 | const uint8_t PIN_NRF_CS = 5;
6 | const uint8_t PIN_NRF_PKT = 4;
7 |
8 | LT8920 lt(PIN_NRF_CS, PIN_NRF_PKT, PIN_NRF_RST);
9 |
10 | uint8_t number = 0;
11 |
12 | void setup()
13 | {
14 | Serial.begin(74880);
15 | SPI.begin();
16 | SPI.setBitOrder(MSBFIRST);
17 | SPI.setClockDivider(SPI_CLOCK_DIV64);
18 | delay(500);
19 | lt.begin();
20 | lt.setCurrentControl(0,0);
21 | lt.setDataRate(LT8920::LT8920_1MBPS);
22 | lt.setChannel(0x20);
23 | }
24 |
25 | void loop()
26 | {
27 | delay(100);
28 | uint8_t data[16];
29 | sprintf((char *)data,"number: %d",number++);
30 | lt.sendPacket(data, strlen((char *)data)+1);
31 | Serial.println((char *)data);
32 | }
33 |
--------------------------------------------------------------------------------
/examples/lt8920test/lt8920test.ino:
--------------------------------------------------------------------------------
1 | #include
2 | #include "LT8920.h"
3 |
4 | const uint8_t PIN_NRF_RST = 16;
5 | const uint8_t PIN_NRF_CS = 5;
6 | const uint8_t PIN_NRF_PKT = 4;
7 | const uint8_t PIN_ROLE = 0;
8 | bool writer;
9 |
10 | LT8920 lt(PIN_NRF_CS, PIN_NRF_PKT, PIN_NRF_RST);
11 |
12 | void setup()
13 | {
14 | Serial.begin(74800);
15 | SPI.begin();
16 | SPI.setBitOrder(MSBFIRST);
17 | SPI.setClockDivider(SPI_CLOCK_DIV16);
18 |
19 | pinMode(PIN_ROLE, INPUT_PULLUP);
20 |
21 | delay(500);
22 |
23 | lt.begin();
24 | lt.setCurrentControl(4,15);
25 | lt.setDataRate(LT8920::LT8920_62KBPS);
26 | lt.setChannel(0x06);
27 |
28 | char sbuf[32];
29 |
30 | //verify chip registers.
31 | for (int i = 0; i <= 50; i++)
32 | {
33 | uint16_t value = lt.readRegister(i);
34 |
35 | sprintf_P(sbuf, PSTR("%d = %04x\r\n"), i, value);
36 | Serial.print(sbuf);
37 | }
38 |
39 | if ((digitalRead(PIN_ROLE) == LOW))
40 | {
41 | writer = true;
42 | Serial.println(F("Writer mode"));
43 | }
44 | else
45 | {
46 | writer = false;
47 | Serial.println(F("Reader mode"));
48 | lt.startListening();
49 | }
50 |
51 | lt.whatsUp(Serial);
52 | Serial.println(F("Boot completed."));
53 | }
54 |
55 | void loop()
56 | {
57 | if (writer)
58 | {
59 | delay(2000);
60 |
61 | //send a packet.
62 | uint8_t data[] = { 1,2,3,4,5 };
63 |
64 | lt.sendPacket(data, 5);
65 | lt.whatsUp(Serial);
66 | }
67 | else
68 | {
69 | if (lt.available())
70 | {
71 | Serial.println(F("Data available"));
72 |
73 | uint8_t buf[32];
74 |
75 | int packetSize = lt.read(buf, 32);
76 | if (packetSize > 0)
77 | {
78 | Serial.println(F("Packet read OK"));
79 |
80 | //dump the packet.
81 | for(int i = 0; i < packetSize; i++)
82 | {
83 | Serial.print(i);
84 | Serial.print("=");
85 | Serial.println(buf[i]);
86 | }
87 | }
88 | else
89 | {
90 | Serial.println(F("Packet read fail"));
91 | lt.whatsUp(Serial);
92 | }
93 |
94 | lt.startListening();
95 | }
96 | }
97 | }
98 |
--------------------------------------------------------------------------------
/examples/scanner/scanner.ino:
--------------------------------------------------------------------------------
1 | #include
2 | #include "LT8920.h"
3 |
4 | const uint8_t PIN_NRF_RST = 16;
5 | const uint8_t PIN_NRF_CS = 5;
6 | const uint8_t PIN_NRF_PKT = 4;
7 | const uint8_t PIN_ROLE = 0;
8 |
9 | LT8920 lt(PIN_NRF_CS, PIN_NRF_PKT, PIN_NRF_RST);
10 |
11 | void setup()
12 | {
13 | Serial.begin(74800);
14 |
15 | SPI.begin();
16 | SPI.setBitOrder(MSBFIRST);
17 | SPI.setClockDivider(SPI_CLOCK_DIV16);
18 |
19 | lt.begin();
20 | lt.setCurrentControl(15,15);
21 | lt.setChannel(0x06);
22 | }
23 |
24 | void loop()
25 | {
26 | uint16_t wifi_Channels[] = {
27 | 2412,
28 | 2417,
29 | 2422,
30 | 2427,
31 | 2432,
32 | 2437,
33 | 2442,
34 | 2447,
35 | 2452,
36 | 2457,
37 | 2462,
38 | 2467,
39 | 2472,
40 | 2484
41 | };
42 |
43 | uint16_t signals[32];
44 | char sbuf[64];
45 |
46 | Serial.println("\n\n");
47 |
48 | for(int i = 0; i < sizeof(wifi_Channels)/sizeof(uint16_t); i++)
49 | {
50 | lt.scanRSSI(&signals[i], wifi_Channels[i]-2402, 1);
51 | }
52 |
53 | for(int i = 0; i < sizeof(wifi_Channels)/sizeof(uint16_t); i++)
54 | {
55 | sprintf(sbuf, "[%02d] %d = %04x ", i+1, wifi_Channels[i], signals[i]);
56 | Serial.print(sbuf);
57 | for(int j =0 ; j < signals[i]/2; j++)
58 | {
59 | Serial.print('#');
60 | }
61 | Serial.println();
62 | }
63 | delay(250);
64 | }
65 |
--------------------------------------------------------------------------------