├── LICENSE
├── NetLog_MK1.ino
├── NetLog_MK1.scad
├── README.md
├── case.stl
├── config.h
├── docs
├── build_tutorial.md
└── flashing_tutorial.md
├── flash_config.h
├── lid_logo.stl
├── lid_text.stl
├── logo.svg
├── pictures
├── assembled_unconnected.jpg
├── case.jpg
├── case_and_lid.jpg
├── case_finished.jpg
├── components.jpg
├── gps_wiring.png
├── gps_wiring.svg
├── insert.jpg
├── jst_conn.jpg
├── lid.jpg
├── screw_lid.jpg
├── side.jpg
├── solder_gps.jpg
├── trim_gps.jpg
└── upload_screenshot.png
└── tools
├── README.md
├── bssidgen.py
└── netmerger.py
/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 |
635 | Copyright (C)
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 | Copyright (C)
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 |
--------------------------------------------------------------------------------
/NetLog_MK1.ino:
--------------------------------------------------------------------------------
1 | /*
2 | NetLog MK1 - The ESP32 WiFi wardriving device
3 |
4 | by Tigersprojects
5 |
6 | ---------------------------------------------
7 |
8 | Designed for an ESP32-S3 with a GPS module.
9 |
10 | Remember to set "USB CDC On Boot" to "Enabled"
11 | and "USB Mode" to "USB-OTG" under the Tools menu.
12 |
13 | You can usually set "Upload Mode" to
14 | "USB-OTG CDC (TinyUSB)" to avoid booting
15 | the device into DFU mode.
16 |
17 | Format the FATFS partition with FAT12 or FAT16
18 | for NetLog MK1 to work properly.
19 | */
20 |
21 | #include
22 |
23 | #include
24 | #include
25 | #include
26 |
27 | #include "SPI.h"
28 | #include "SdFat_Adafruit_Fork.h"
29 | #include "Adafruit_SPIFlash.h"
30 | #include "Adafruit_TinyUSB.h"
31 |
32 | // For flashTransport definition
33 | #include "flash_config.h"
34 |
35 | #include "config.h"
36 |
37 | // Define stuff
38 | String cur_ssid, csv_str;
39 |
40 | char cur_bssid[18],
41 | temp_bssid[18],
42 | newline_bssid[19],
43 | temp_char;
44 |
45 | bool exists = false,
46 | gps_new_data = false,
47 | flash_busy = false;
48 |
49 | HardwareSerial neogps(1);
50 | Adafruit_SPIFlash flash(&flashTransport);
51 |
52 | FatVolume fatfs;
53 | FatFile bssid_file;
54 |
55 | TinyGPSPlus gps;
56 | Adafruit_USBD_MSC usb_msc;
57 |
58 |
59 | // Checks if a file exists
60 | bool fileExists(const char *path) {
61 | FatFile file = fatfs.open(path);
62 |
63 | bool exists = file;
64 | if (exists) file.close();
65 |
66 | return exists;
67 | }
68 |
69 |
70 | // Prints to a file
71 | void fileAppend(const char *path, const char *message) {
72 | File file = fatfs.open(path, FILE_WRITE);
73 |
74 | if (!file) return;
75 |
76 | file.print(message);
77 | file.close();
78 | }
79 |
80 |
81 | // Returns a CSV-safe string
82 | String CSVSafeString(String input) {
83 | String output = "";
84 |
85 | // Double all quotes
86 | for (int c = 0; c < input.length(); c++) {
87 | output += ((input.charAt(c) == '"') ? "\"\"" : String(input.charAt(c)));
88 | }
89 |
90 | // Append and prepend quotes to the output
91 | output = "\"" + output + "\"";
92 | return output;
93 | }
94 |
95 |
96 | // Setup
97 | void setup() {
98 |
99 | // Init NeoPixel
100 | rgb.begin();
101 |
102 | rgb.setPixelColor(0, rgb.Color(255, 255, 0));
103 | rgb.setBrightness(neopixel_brightness);
104 |
105 | rgb.show();
106 |
107 | // Init WiFi
108 | WiFi.mode(WIFI_STA);
109 | WiFi.disconnect();
110 |
111 | delay(500);
112 |
113 | // Init storage
114 | flash.begin();
115 |
116 | // Configure TinyUSB
117 | TinyUSBDevice.setManufacturerDescriptor(netlog_vid);
118 | TinyUSBDevice.setProductDescriptor(netlog_name);
119 |
120 | // Configure usb_msc
121 | usb_msc.setID(netlog_vid, netlog_name, netlog_ver);
122 | usb_msc.setReadWriteCallback(msc_read_cb, msc_write_cb, msc_flush_cb);
123 | usb_msc.setCapacity(flash.size() / 512, 512);
124 |
125 | usb_msc.setUnitReady(true);
126 | usb_msc.begin();
127 |
128 | // Reattach if already mounted
129 | if (TinyUSBDevice.mounted()) {
130 | TinyUSBDevice.detach();
131 | delay(10);
132 | TinyUSBDevice.attach();
133 | }
134 |
135 | // Init flash FS
136 | while (!fatfs.begin(&flash)) {
137 | rgb.setPixelColor(0, rgb.Color(255, 0, 0));
138 | rgb.show();
139 |
140 | delay(1000);
141 | }
142 |
143 | // Create necessary files if they don't exist
144 | if (!fileExists(data_filename)) {
145 | flash_busy = true;
146 | fileAppend(data_filename, "\"ssid\",\"bssid\",\"rssi\",\"auth\",\"coord\",\"speed\"\n");
147 | flash_busy = false;
148 | }
149 |
150 | if (!fileExists(bssid_filename)) {
151 | flash_busy = true;
152 | fileAppend(bssid_filename, "");
153 | flash_busy = false;
154 | }
155 |
156 | // Connect to GPS
157 | neogps.begin(GPS_BAUD, SERIAL_8N1, GPS_RXD2, GPS_TXD2);
158 | delay(500);
159 |
160 | // Startup successful (with cool fade effect)
161 | for (int b = 0; b < neopixel_brightness; b++) {
162 | rgb.setBrightness(neopixel_brightness - b);
163 | rgb.show();
164 |
165 | delay(5);
166 | }
167 |
168 | rgb.setPixelColor(0, rgb.Color(0, 0, 0));
169 | rgb.setBrightness(neopixel_brightness);
170 | rgb.show();
171 |
172 | // Poll the GPS module for 1s to see if there is available data from it
173 | for (unsigned long start = millis(); millis() - start < 1000;) {
174 | while (neogps.available()) {
175 | if (gps.encode(neogps.read())) {
176 | gps_new_data = true;
177 | }
178 | }
179 | }
180 | }
181 |
182 |
183 | // Loop
184 | void loop() {
185 |
186 | // Check if there is available data from the GPS module
187 | while (neogps.available()) {
188 | if (gps.encode(neogps.read())) {
189 | gps_new_data = true;
190 | }
191 | }
192 |
193 | // Start scanning networks if the GPS module has a fix
194 | if (gps.location.isValid() && gps.satellites.value() >= minimum_satellites) {
195 |
196 | // Make sure the NeoPixel is off
197 | rgb.setPixelColor(0, rgb.Color(0, 0, 0));
198 | rgb.show();
199 |
200 | // Scan networks
201 | unsigned long networks_found = WiFi.scanNetworks();
202 |
203 | // Search for new networks
204 | for (int i = 0; i < networks_found; i++) {
205 |
206 | // Get SSID and stop at newline char ('\n')
207 | // (Yes, you can put newlines in SSIDs)
208 | cur_ssid = WiFi.SSID(i).substring(0, WiFi.SSID(i).indexOf('\n'));
209 |
210 | // Get BSSID
211 | memset(cur_bssid, '\0', 18);
212 | WiFi.BSSIDstr(i).toCharArray(cur_bssid, 18);
213 |
214 | // Open BSSID file and make sure the BSSID doesn't already exist
215 | bssid_file = fatfs.open(bssid_filename);
216 | exists = false;
217 |
218 | while (bssid_file.available()) {
219 |
220 | // Check first character for better speed
221 | temp_char = bssid_file.read();
222 |
223 | if (temp_char == cur_bssid[0]) {
224 |
225 | // Read entire string if the characters match
226 | memset(temp_bssid, '\0', 18);
227 |
228 | while (temp_char != '\n' && bssid_file.available() && strlen(temp_bssid) < 17) {
229 | strncat(temp_bssid, &temp_char, 1);
230 | temp_char = bssid_file.read();
231 | }
232 |
233 | if (strcmp(temp_bssid, cur_bssid) == 0) {
234 | exists = true;
235 | break;
236 | }
237 |
238 | } else {
239 |
240 | // Go to next newline if the characters don't match
241 | while (bssid_file.read() != '\n');
242 | }
243 | }
244 |
245 | bssid_file.close();
246 |
247 |
248 | // Save network info
249 | if (!exists) {
250 |
251 | // Flash NeoPixel to signal new network
252 | rgb.setPixelColor(0, rgb.Color(255, 255, 255));
253 | rgb.show();
254 |
255 | delay(100);
256 |
257 | rgb.setPixelColor(0, rgb.Color(0, 0, 0));
258 | rgb.show();
259 |
260 | delay(100);
261 |
262 | // Add SSID, BSSID, and RSSI to CSV file
263 | csv_str = CSVSafeString(cur_ssid) + "," +
264 | CSVSafeString(cur_bssid) + "," +
265 | CSVSafeString(String(WiFi.RSSI(i)) + " dBm") + ",";
266 |
267 | // Append auth to CSV file
268 | switch (WiFi.encryptionType(i)) {
269 | case WIFI_AUTH_OPEN:
270 | csv_str += CSVSafeString("Open"); break;
271 |
272 | case WIFI_AUTH_WEP:
273 | csv_str += CSVSafeString("WEP"); break;
274 |
275 | case WIFI_AUTH_WPA_PSK:
276 | csv_str += CSVSafeString("WPA PSK"); break;
277 |
278 | case WIFI_AUTH_WPA2_PSK:
279 | csv_str += CSVSafeString("WPA2 PSK"); break;
280 |
281 | case WIFI_AUTH_WPA_WPA2_PSK:
282 | csv_str += CSVSafeString("WPA WPA2 PSK"); break;
283 |
284 | case WIFI_AUTH_WPA2_ENTERPRISE:
285 | csv_str += CSVSafeString("WPA2 Enterprise"); break;
286 |
287 | case WIFI_AUTH_WPA3_PSK:
288 | csv_str += CSVSafeString("WPA3 PSK"); break;
289 |
290 | case WIFI_AUTH_WPA2_WPA3_PSK:
291 | csv_str += CSVSafeString("WPA2 WPA3 PSK"); break;
292 |
293 | case WIFI_AUTH_WAPI_PSK:
294 | csv_str += CSVSafeString("WAPI PSK"); break;
295 |
296 | default:
297 | csv_str += CSVSafeString(String("Unknown Auth (" +
298 | String(WiFi.encryptionType(i)) + ")"));
299 | break;
300 |
301 | } csv_str += ",";
302 |
303 | // Save NetLog position and speed (skipping altitude)
304 | csv_str += CSVSafeString(String(
305 | ((gps.location.lat() >= 0) ? "+" : "") + String(gps.location.lat(), 6) + " " +
306 | ((gps.location.lng() >= 0) ? "+" : "") + String(gps.location.lng(), 6)
307 | )) + ",";
308 |
309 | csv_str += CSVSafeString(String(gps.speed.kmph(), 1) + " km/h") + "\n";
310 |
311 | // Create BSSID with a newline
312 | memset(newline_bssid, '\0', 19);
313 | strncpy(newline_bssid, cur_bssid, 18);
314 | strncat(newline_bssid, "\n", 1);
315 |
316 | // Append data to files
317 | flash_busy = true;
318 |
319 | if (!fileExists(data_filename))
320 | fileAppend(data_filename, "\"ssid\",\"bssid\",\"rssi\",\"auth\",\"coord\",\"speed\"\n");
321 |
322 | fileAppend(data_filename, csv_str.c_str());
323 | fileAppend(bssid_filename, newline_bssid);
324 |
325 | flash_busy = false;
326 | }
327 | }
328 |
329 | } else {
330 | if (!gps_new_data) {
331 |
332 | // No connection to GPS module
333 | rgb.setPixelColor(0, rgb.Color(255, 0, 0));
334 | rgb.show();
335 |
336 | delay(500);
337 |
338 | rgb.setPixelColor(0, rgb.Color(0, 0, 0));
339 | rgb.show();
340 |
341 | } else {
342 |
343 | // Searching for satellites
344 | rgb.setPixelColor(0, rgb.Color(0, 255, 0));
345 | rgb.show();
346 |
347 | delay(500);
348 |
349 | rgb.setPixelColor(0, rgb.Color(0, 0, 0));
350 | rgb.show();
351 | }
352 |
353 | delay(500);
354 | }
355 | }
356 |
357 |
358 | // Callback for read command
359 | int32_t msc_read_cb(uint32_t lba, void *buffer, uint32_t bufsize) {
360 | while (flash_busy);
361 |
362 | int32_t block = flash.readBlocks(lba, (uint8_t*)buffer, bufsize / 512) ? bufsize : -1;
363 |
364 | return block;
365 | }
366 |
367 |
368 | // Callback for write command
369 | int32_t msc_write_cb(uint32_t lba, uint8_t *buffer, uint32_t bufsize) {
370 | while (flash_busy);
371 |
372 | int32_t block = flash.writeBlocks(lba, buffer, bufsize / 512) ? bufsize : -1;
373 |
374 | return block;
375 | }
376 |
377 |
378 | // Callback for flush command
379 | void msc_flush_cb(void) {
380 | while (flash_busy);
381 |
382 | flash.syncBlocks();
383 | fatfs.cacheClear();
384 | }
385 |
--------------------------------------------------------------------------------
/NetLog_MK1.scad:
--------------------------------------------------------------------------------
1 | /*
2 | Case for the NetLog MK1.
3 |
4 | Use with M3 threaded inserts
5 | and M3 hex socket cap screws.
6 |
7 | This file is a mess.
8 | */
9 |
10 |
11 | $fn=30;
12 |
13 | // Area for the components, e.g. GPS module, MCU, antenna //
14 | case_x = 60;
15 | case_y = 70;
16 | case_z = 9;
17 |
18 | // Mainboard size //
19 | mainb_l = 65.5;
20 | mainb_w = 25.5;
21 | mainb_h = 1;
22 |
23 | // GPS module size //
24 | gps_l = 36.75;
25 | gps_w = 26.25;
26 | gps_h = 1.5;
27 |
28 | // GPS antenna size //
29 | gpsa_l = 28.5;
30 | gpsa_w = 28.5;
31 | gpsa_h = 9;
32 |
33 | // Mainboard USB-C connector offsets //
34 | mainb_usb_x = 16;
35 | mainb_usb_z = 0.75;
36 |
37 | // Tolerance offset //
38 | tolerance_offset = 0.25;
39 |
40 | // Other stuff //
41 | wall_thickness = 2;
42 |
43 | box = true;
44 | lid = true;
45 |
46 | lid_thickness = 4;
47 |
48 | text_font = "Space Mono:style=Bold";
49 |
50 | logo_path = "logo.svg";
51 | logo_dpi = 64;
52 |
53 |
54 | /*
55 | * Puts the logo defined by logo_path in
56 | * the bottom right corner instead
57 | * of the "NetLog MK1" text.
58 | */
59 | use_logo = false;
60 |
61 |
62 | // A hole for a screw //
63 | module screwHole() {
64 | translate([2.75, 2.875, 3]) cylinder(1, d=3.5);
65 | translate([2.75, 2.875]) cylinder(3, d=5.75);
66 | }
67 |
68 |
69 | // Box //
70 | if (box) {
71 |
72 | // Rounded corners //
73 | for (i = [0 : 1 : 1]) {
74 | difference() {
75 |
76 | translate([
77 | 5 + i * (case_x + wall_thickness * 2), 5
78 | ]) hull() {
79 |
80 | cylinder(case_z + wall_thickness, d=5 * 2);
81 |
82 | translate([0, case_y - 10 + wall_thickness * 2])
83 | cylinder(case_z + wall_thickness, d=5 * 2);
84 | }
85 |
86 | translate([
87 | 5 + i * (case_x + wall_thickness * 2 - 5), 0
88 | ]) cube([
89 | 5, case_y + wall_thickness * 2,
90 | case_z + wall_thickness
91 | ]);
92 |
93 |
94 | // Holes for screws //
95 | for (j = [0 : 1 : 1]) translate([
96 | i * (case_x + 5 + wall_thickness * 2 - 2) + 3.5,
97 |
98 | 10 + j *
99 | (case_y - 20 + wall_thickness * 2),
100 |
101 | case_z + wall_thickness - 10.5
102 | ]) cylinder(10.5, d=4);
103 | }
104 | }
105 |
106 | translate([5, 0]) {
107 |
108 | // Box for the components //
109 | difference() {
110 | cube([
111 | case_x + wall_thickness * 2,
112 | case_y + wall_thickness * 2,
113 | case_z + wall_thickness
114 | ]);
115 |
116 | translate([wall_thickness, wall_thickness, wall_thickness]) cube([
117 | case_x,
118 | case_y,
119 | case_z
120 | ]);
121 |
122 |
123 | // Holes for screws //
124 | for (i = [0 : 1 : 1]) for (j = [0 : 1 : 1]) translate([
125 | i * (case_x + 5 + wall_thickness * 2 - 2) - 1.5,
126 |
127 | 10 + j *
128 | (case_y - 20 + wall_thickness * 2),
129 |
130 | case_z + wall_thickness - 10.5
131 | ]) cylinder(10.5, d=4);
132 |
133 |
134 | // Small pits under GPS module //
135 | translate([
136 | case_x - gps_w + wall_thickness,
137 | case_y - gps_l + wall_thickness,
138 | wall_thickness / 2
139 | ]) cube([gps_w, 5, wall_thickness / 2]);
140 |
141 | translate([
142 | case_x - gps_w + wall_thickness,
143 | case_y - 5 + wall_thickness,
144 | wall_thickness / 2
145 | ]) cube([gps_w, 5, wall_thickness / 2]);
146 |
147 |
148 | // Hole for USB-C port //
149 | translate([
150 | wall_thickness + 1.875 + mainb_usb_x,
151 | wall_thickness * 2 + case_y,
152 | wall_thickness + 1.875 + mainb_usb_z
153 | ]) {
154 |
155 | rotate([90, 90]) {
156 | hull() {
157 | cylinder(wall_thickness, d=3.5);
158 | translate([0, 5]) cylinder(wall_thickness, d=3.5);
159 | }
160 | }
161 | }
162 |
163 | // Make the wall thinner where the mainboard goes
164 | translate([wall_thickness, wall_thickness + case_y, wall_thickness])
165 | cube([mainb_w, wall_thickness / 2, case_z]);
166 | }
167 |
168 | // Holders for the mainboard //
169 | translate([wall_thickness + mainb_w, wall_thickness, wall_thickness])
170 | cube([wall_thickness, case_y, mainb_h]);
171 |
172 | translate([wall_thickness, wall_thickness, wall_thickness])
173 | cube([mainb_w, case_y - mainb_l + wall_thickness / 2, mainb_h]);
174 |
175 | // Holders for the GPS module //
176 | translate([case_x - gps_w, case_y - gps_l, wall_thickness])
177 | cube([wall_thickness, gps_l + wall_thickness, gps_h]);
178 |
179 | translate([
180 | case_x - gps_w + wall_thickness,
181 | case_y - gps_l,
182 | wall_thickness
183 | ]) cube([gps_w, wall_thickness, gps_h]);
184 |
185 |
186 | // Holders for the GPS antenna //
187 | difference() {
188 | translate([case_x - gpsa_w, wall_thickness, wall_thickness])
189 | cube([gpsa_w + wall_thickness, gpsa_l + wall_thickness, gpsa_h]);
190 |
191 | translate([
192 | case_x - gpsa_w + wall_thickness,
193 | wall_thickness,
194 | wall_thickness
195 | ]) cube([gpsa_w, gpsa_l, gpsa_h]);
196 |
197 | translate([
198 | case_x - gpsa_w / 2 + wall_thickness - 5,
199 | gpsa_l + wall_thickness,
200 | wall_thickness
201 | ]) cube([10, wall_thickness, gpsa_h]);
202 |
203 | translate([
204 | case_x - gpsa_w,
205 | gpsa_l / 2 + wall_thickness - 5,
206 | wall_thickness
207 | ]) cube([wall_thickness, 10, gpsa_h]);
208 | }
209 | }
210 | }
211 |
212 |
213 | // Lid //
214 | if (lid) {
215 | translate([0, case_y + wall_thickness * 2 + 10]) {
216 |
217 | // Rounded corners //
218 | for (i = [0 : 1 : 1]) {
219 | difference() {
220 |
221 | translate([
222 | 5 + i * (case_x + wall_thickness * 2), 5
223 | ]) hull() {
224 |
225 | cylinder(lid_thickness, d=5 * 2);
226 |
227 | translate([0, case_y - 10 + wall_thickness * 2])
228 | cylinder(lid_thickness, d=5 * 2);
229 | }
230 |
231 | translate([
232 | 5 + i * (case_x + wall_thickness * 2 - 5), 0
233 | ]) cube([
234 | 5, case_y + wall_thickness * 2,
235 | lid_thickness
236 | ]);
237 |
238 |
239 | // Screw holes //
240 | for (j = [0 : 1 : 1]) translate([
241 | i * (case_x + 5 + wall_thickness * 2 - 2) + 0.75,
242 |
243 | 7.125 + j *
244 | (case_y - 20 + wall_thickness * 2), 0
245 | ]) screwHole();
246 | }
247 | }
248 |
249 |
250 | // Box for the lid //
251 | difference() {
252 | translate([5, 0]) cube([
253 | case_x + wall_thickness * 2,
254 | case_y + wall_thickness * 2,
255 | lid_thickness
256 | ]);
257 |
258 | if (use_logo) {
259 | // Logo //
260 | translate([case_x / 1.2 + 2 + wall_thickness,
261 | case_y / 1.2 + wall_thickness * 2 - 2])
262 |
263 | rotate([0, 0, 180]) linear_extrude(1)
264 | import(logo_path, center=true, logo_dpi);
265 | } else {
266 |
267 | // "NetLog MK1" text //
268 | translate([
269 | case_x / 2 + 5 + wall_thickness,
270 | case_y + wall_thickness * 2 - 2,
271 | wall_thickness / 2
272 | ]) rotate([180]) linear_extrude(wall_thickness / 2)
273 | text(
274 | "NetLog MK1",
275 | 6, font=text_font,
276 | halign="center",
277 | valign="bottom"
278 | );
279 | }
280 |
281 |
282 | // More screw holes //
283 | for (i = [0 : 1 : 1]) for (j = [0 : 1 : 1]) translate([
284 | i * (case_x + 5 + wall_thickness * 2 - 2) + 0.75,
285 |
286 | 7.125 + j *
287 | (case_y - 20 + wall_thickness * 2), 0
288 | ]) screwHole();
289 | }
290 |
291 |
292 | // Support for the thin mainboard wall //
293 | translate([5 + wall_thickness + tolerance_offset,
294 | tolerance_offset + wall_thickness / 2, lid_thickness])
295 |
296 | cube([mainb_w - tolerance_offset * 2, wall_thickness, 1]);
297 |
298 |
299 | translate([
300 | 5 + wall_thickness,
301 | wall_thickness,
302 | lid_thickness
303 | ]) {
304 |
305 | // Holders for mainboard //
306 | for (i = [0 : 1 : 1]) translate([
307 | tolerance_offset + i * (mainb_w - wall_thickness - tolerance_offset * 2),
308 | case_y - 45 - tolerance_offset - (case_y - mainb_l)
309 | ]) cube([wall_thickness, 45, case_z - mainb_h]);
310 |
311 |
312 | // Holder for GPS antenna (+0.25mm height) //
313 | translate([
314 | case_x + tolerance_offset - gpsa_w,
315 | case_y + tolerance_offset - gpsa_l
316 | ]) cube([
317 | gpsa_w - tolerance_offset * 2,
318 | gpsa_l - tolerance_offset * 2,
319 | case_z - gpsa_h + 0.25
320 | ]);
321 |
322 |
323 | // Holders for GPS module (+0.25mm height) //
324 | for (i = [0 : 1 : 1]) for (j = [0 : 1 : 1]) translate([
325 | case_x - 5 - tolerance_offset - i * (gps_w - 5 - tolerance_offset * 2),
326 | tolerance_offset + j * (gps_l - 5 - tolerance_offset * 2),
327 | ]) cube([5, 5, case_z - gps_h + 0.25]);
328 | }
329 | }
330 | }
331 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # NetLog MK1
2 | 
3 | The NetLog MK1 is a WiFi network scanning (wardriving) device based on
4 | the ESP32-S3 and an inexpensive GPS module.
5 |
6 | The NetLog MK1 is designed to be operated from a power bank or car USB charger.
7 | The networks are stored in a CSV file on a FAT12 or FAT16 filesystem.
8 |
9 | The NetLog MK1 will appear as a USB drive once connected to a computer.
10 | From there, you can open the CSV file with any spreadsheet software (like LibreOffice, Google Sheets, etc).
11 |
12 | - [Build your own](docs/build_tutorial.md)
13 | - [Flashing the firmware](docs/flashing_tutorial.md)
14 |
15 | ## RGB LED Light Codes
16 | | Light Code | Meaning |
17 | |----------------|---------------------------------------|
18 | | Static yellow | Device starting |
19 | | Static red | FS error (format with FAT12 or FAT16) |
20 | | Blinking green | Establishing GPS fix |
21 | | Blinking red | No connection to GPS module |
22 | | White blink | Network found |
23 |
--------------------------------------------------------------------------------
/case.stl:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/case.stl
--------------------------------------------------------------------------------
/config.h:
--------------------------------------------------------------------------------
1 | #ifndef CONFIG_H_
2 | #define CONFIG_H_
3 |
4 | // Lolin S3 Pro //
5 | Adafruit_NeoPixel rgb(1, 38, NEO_RGBW + NEO_KHZ800);
6 |
7 | // NeoPixel brightness from 0 - 255 //
8 | const uint8_t neopixel_brightness = 100;
9 |
10 | // Minimum amount of satellites to start collecting networks //
11 | const unsigned int minimum_satellites = 3;
12 |
13 | // Filenames //
14 | const char *data_filename = "NetLog_data.csv",
15 | *bssid_filename = "NetLog_bssids.txt",
16 |
17 | // USB info //
18 | *netlog_ver = "1.17",
19 | *netlog_vid = "NetLog",
20 | *netlog_name = "NetLog MK1";
21 |
22 | // For the GY-NEO6MV2 (and many other GPS modules) //
23 | #define GPS_BAUD 9600
24 |
25 | // Lolin S3 Pro //
26 | #define GPS_RXD2 10
27 | #define GPS_TXD2 9
28 | #endif
29 |
--------------------------------------------------------------------------------
/docs/build_tutorial.md:
--------------------------------------------------------------------------------
1 | # Building a NetLog MK1
2 | To build a NetLog MK1, you need the following tools and parts:
3 |
4 | | Tools |
5 | |-----------------------|
6 | | Soldering iron |
7 | | Flushcutters |
8 | | 3D printer |
9 | | Wire strippers |
10 | | 2.5mm hex screwdriver |
11 |
12 | | Parts |
13 | |----------------------------------|
14 | | LOLIN S3 Pro dev board |
15 | | 4x M3 threaded inserts |
16 | | 4x 10mm M3 hex socket cap screws |
17 | | GY-NEO6MV2 GPS module |
18 | | 28 x 28 x ~9mm uFL GPS antenna |
19 | | JST SH 4-pin connector |
20 | | 4x JST SH cables |
21 |
22 | ## Step 1: Building the case
23 | Print `case.stl` with PLA or PET(G). Next, insert four M3 threaded inserts into the screw holes.
24 | 
25 |
26 | When you're done, the case should look something like this:
27 | 
28 |
29 | ## Step 2: Preparing the GPS module
30 | Next, we'll connect a JST SH (1.0mm) 4-pin cable to the GPS module.
31 |
32 | I recommend getting a set that has pre-crimped cables, as manually crimping these connectors can be difficult.
33 | 
34 |
35 | Insert the cables into the connector and cut the ends so they are about
36 | 5cm long. Strip the ends of the cables, then solder them to the GPS module with the pinout shown in the image below:
37 | 
38 |
39 | This is what the result should look like:
40 | 
41 |
42 | For the GPS module to fit in the case, you will need to trim the solder blobs on the bottom of the GPS module:
43 | 
44 |
45 | ## Step 3: Printing the cover
46 | Print `lid_text.stl` or `lid_logo.stl` with **clear** PLA or PET(G). This is so that the LEDs can shine through the cover.
47 | 
48 | Those weird towers on the cover hold the components in place.
49 |
50 | > `lid_text.stl` reads _NetLog MK1_ on the bottom of the cover, whereas `lid_logo.stl` has the the NetLog MK1 logo (found in `logo.svg`) in the
51 | bottom right corner. The difference is purely cosmetic and has no effect on functionality. I'll use `lid_text.stl` for the tutorial.
52 |
53 | ## Step 4: Assembling the device
54 | Now we have the case, cover, and components ready for assembly.
55 | 
56 |
57 | Put the components in the case like this:
58 | 
59 |
60 | > Note: Due to tight tolerances, getting the components in their slots may take some force.
61 |
62 | Next, connect the JST cable of the GPS module into the S3 Pro's I2C port, and the GPS antenna's uFL connector to the GPS module.
63 | 
64 |
65 | > While the 4-pin JST connector on the S3 Pro is intended for I2C,
66 | the versatility of the ESP32's GPIO pins allows us to use it for
67 | UART as well.
68 |
69 | > Before attaching the cover, it may be a good idea to [flash the firmware.](flashing_tutorial.md)
70 |
71 | Now, we can screw the cover onto the case:
72 | 
73 |
74 | With this, your NetLog MK1 is finished!
75 | In case you haven't already, you now just have to [flash the firmware.](flashing_tutorial.md)
76 |
--------------------------------------------------------------------------------
/docs/flashing_tutorial.md:
--------------------------------------------------------------------------------
1 | # Flashing the Firmware
2 |
3 | Open `NetLog_MK1.ino` in Arduino IDE and install the following boards and libraries:
4 |
5 | 1. [Install the ESP32 boards](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html)
6 |
7 | 2. Install the following libraries:
8 | - TinyGPSPlus
9 | - Adafruit NeoPixel
10 | - SdFat - Adafruit Fork
11 | - Adafruit SPIFlash
12 | - Adafruit TinyUSB Library
13 |
14 | If you want, you can configure some parameters in `config.h`. Next,
15 | select `LOLIN S3 Pro` and the connected serial port in the board selector.
16 |
17 | Then, under the _Tools_ menu:
18 |
19 | - enable _USB CDC On Boot_
20 | - set _USB Mode_ to _USB-OTG (TinyUSB)_
21 | - set _Partition Scheme_ to _16M Flash (2MB APP/12.5MB FATFS)_
22 |
23 | Once you've done that, upload the sketch by clicking on the upload button.
24 | 
25 |
26 | > Flashing the firmware through hardware CDC is not possible
27 | once the device is mounted as a USB flash drive.
28 | Instead of booting it into DFU mode, you can set _Upload Mode_ to
29 | _USB-OTG CDC (TinyUSB)_.
30 |
31 | Once you've flashed the firmware and restarted the device, the LED will glow yellow and then turn solid red.
32 | This indicates a filesystem error, as we first have to format the FATFS partition with FAT12 or FAT16.
33 |
34 | On Linux, you can format the device by running `sudo mkfs.vfat /dev/sdX`,
35 | with `sdX` being the block device, which you can find by running `lsblk`.
36 |
37 | Now the device should be ready for use.
38 |
39 | > The BSSIDs text file the device creates contains the BSSID
40 | of every network it has already found (all networks it should ignore).
41 |
--------------------------------------------------------------------------------
/flash_config.h:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License (MIT)
3 | *
4 | * Copyright (c) 2022 Ha Thach (tinyusb.org) for Adafruit Industries
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 |
25 | #ifndef FLASH_CONFIG_H_
26 | #define FLASH_CONFIG_H_
27 |
28 | // Un-comment to run example with custom SPI and SS e.g with FRAM breakout
29 | // #define CUSTOM_CS A5
30 | // #define CUSTOM_SPI SPI
31 |
32 | #if defined(CUSTOM_CS) && defined(CUSTOM_SPI)
33 | Adafruit_FlashTransport_SPI flashTransport(CUSTOM_CS, CUSTOM_SPI);
34 |
35 | #elif defined(ARDUINO_ARCH_ESP32)
36 |
37 | // ESP32 use same flash device that store code for file system.
38 | // SPIFlash will parse partition.cvs to detect FATFS partition to use
39 | Adafruit_FlashTransport_ESP32 flashTransport;
40 |
41 | #elif defined(ARDUINO_ARCH_RP2040)
42 |
43 | // RP2040 use same flash device that store code for file system. Therefore we
44 | // only need to specify start address and size (no need SPI or SS)
45 | // By default (start=0, size=0), values that match file system setting in
46 | // 'Tools->Flash Size' menu selection will be used.
47 | Adafruit_FlashTransport_RP2040 flashTransport;
48 |
49 | // To be compatible with CircuitPython partition scheme (start_address = 1 MB,
50 | // size = total flash - 1 MB) use const value (CPY_START_ADDR, CPY_SIZE) or
51 | // subclass Adafruit_FlashTransport_RP2040_CPY. Un-comment either of the
52 | // following line:
53 | // Adafruit_FlashTransport_RP2040
54 | // flashTransport(Adafruit_FlashTransport_RP2040::CPY_START_ADDR,
55 | // Adafruit_FlashTransport_RP2040::CPY_SIZE);
56 | // Adafruit_FlashTransport_RP2040_CPY flashTransport;
57 |
58 | #else
59 |
60 | // On-board external flash (QSPI or SPI) macros should already
61 | // defined in your board variant if supported
62 | // - EXTERNAL_FLASH_USE_QSPI
63 | // - EXTERNAL_FLASH_USE_CS/EXTERNAL_FLASH_USE_SPI
64 |
65 | #if defined(EXTERNAL_FLASH_USE_QSPI)
66 |
67 | Adafruit_FlashTransport_QSPI flashTransport;
68 |
69 | #elif defined(EXTERNAL_FLASH_USE_SPI)
70 |
71 | Adafruit_FlashTransport_SPI flashTransport(EXTERNAL_FLASH_USE_CS,
72 | EXTERNAL_FLASH_USE_SPI);
73 |
74 | #else
75 | #error No (Q)SPI flash are defined for your board !
76 | #endif
77 | #endif
78 |
79 | #endif
80 |
--------------------------------------------------------------------------------
/lid_logo.stl:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/lid_logo.stl
--------------------------------------------------------------------------------
/lid_text.stl:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/lid_text.stl
--------------------------------------------------------------------------------
/logo.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
162 |
--------------------------------------------------------------------------------
/pictures/assembled_unconnected.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/assembled_unconnected.jpg
--------------------------------------------------------------------------------
/pictures/case.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/case.jpg
--------------------------------------------------------------------------------
/pictures/case_and_lid.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/case_and_lid.jpg
--------------------------------------------------------------------------------
/pictures/case_finished.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/case_finished.jpg
--------------------------------------------------------------------------------
/pictures/components.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/components.jpg
--------------------------------------------------------------------------------
/pictures/gps_wiring.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/gps_wiring.png
--------------------------------------------------------------------------------
/pictures/gps_wiring.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
224 |
--------------------------------------------------------------------------------
/pictures/insert.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/insert.jpg
--------------------------------------------------------------------------------
/pictures/jst_conn.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/jst_conn.jpg
--------------------------------------------------------------------------------
/pictures/lid.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/lid.jpg
--------------------------------------------------------------------------------
/pictures/screw_lid.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/screw_lid.jpg
--------------------------------------------------------------------------------
/pictures/side.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/side.jpg
--------------------------------------------------------------------------------
/pictures/solder_gps.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/solder_gps.jpg
--------------------------------------------------------------------------------
/pictures/trim_gps.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/trim_gps.jpg
--------------------------------------------------------------------------------
/pictures/upload_screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tigersprojects/NetLog_MK1/37cccc08eda9ca60501b2e5eab621798f226c3e8/pictures/upload_screenshot.png
--------------------------------------------------------------------------------
/tools/README.md:
--------------------------------------------------------------------------------
1 | # Tools
2 | This directory contains some miscellaneous tools for processing files.
3 |
4 | Before using the tools, you may need to run `chmod +x `.
5 |
6 | These are very quick and dirty, but get the job done.
7 |
8 | ## `netmerger.py`
9 | Usage: `python3 netmerger.py [-h] [-o OUTPUT] [-v] files [files ...]`
10 |
11 | Example: `python3 netmerger.py networks.csv morenetworks.csv foo/*.csv -o allnetworks.csv`
12 |
13 | Description: Merges and deduplicates NetLog CSV files.
14 |
15 | ## `bssidgen.py`
16 | Usage: `python3 bssidgen.py [-h] infile outfile`
17 |
18 | Example: `python3 bssidgen.py mynetworks.csv NetLog_bssids.txt`
19 |
20 | Description: Generates a BSSID text file from a NetLog CSV file.
--------------------------------------------------------------------------------
/tools/bssidgen.py:
--------------------------------------------------------------------------------
1 | #!/bin/env python3
2 |
3 | """
4 |
5 | Generates a BSSID text file from a NetLog CSV file.
6 |
7 | This tool is useful if you only have a NetLog CSV file,
8 | but still want to load it onto your NetLog MK1 device.
9 |
10 | """
11 |
12 | import csv
13 | import argparse
14 | import sys
15 | import os
16 |
17 | bssid_field = 'bssid'
18 |
19 | # Argparser
20 | parser = argparse.ArgumentParser(
21 | prog=sys.argv[0],
22 | description='Generates a BSSID text file from a NetLog CSV file.',
23 | formatter_class=argparse.RawDescriptionHelpFormatter,
24 | epilog='This tool is useful if you only have a NetLog CSV file,\n'
25 | 'but still want to load it onto your NetLog MK1 device.')
26 |
27 | parser.add_argument('infile')
28 | parser.add_argument('outfile')
29 |
30 | args = parser.parse_args()
31 |
32 | # Make sure infile exists
33 | if not os.path.isfile(args.infile):
34 | print(f'{sys.argv[0]}: {args.infile}: not a file')
35 | sys.exit(1)
36 |
37 | # Read and parse infile
38 | infile_rows = []
39 |
40 | with open(args.infile, 'r', newline='') as csvfile:
41 | reader = csv.reader(csvfile, delimiter=',',
42 | quotechar='"', lineterminator='\n')
43 |
44 | for i, row in enumerate(reader):
45 | if i == 0:
46 | infile_header = row
47 | else:
48 | infile_rows.append(row)
49 |
50 | # Get index of BSSID column
51 | header_index = 0
52 |
53 | if bssid_field not in infile_header:
54 | print(f"{sys.argv[0]}: {args.infile} does not contain '{bssid_field}' header.")
55 | sys.exit(1)
56 | else:
57 | header_index = infile_header.index(bssid_field)
58 |
59 | # Write BSSIDs to outfile
60 | with open(args.outfile, 'w') as fw:
61 | for row in infile_rows:
62 | fw.write(row[header_index] + '\n')
63 |
64 |
--------------------------------------------------------------------------------
/tools/netmerger.py:
--------------------------------------------------------------------------------
1 | #!/bin/env python3
2 |
3 | """
4 |
5 | Merges and deduplicates NetLog CSV files.
6 |
7 | This tool is slow and basic, but gets the job done.
8 |
9 | """
10 |
11 | import argparse
12 | import csv
13 | import sys
14 | import os
15 |
16 | fieldnames = ['ssid', 'bssid', 'rssi', 'auth', 'coord', 'speed']
17 |
18 | # Argparser
19 | parser = argparse.ArgumentParser(
20 | prog=sys.argv[0],
21 | description='Merges and deduplicates NetLog CSV files.',
22 | epilog='This tool is slow and basic, but gets the job done.')
23 |
24 | parser.add_argument('files', nargs='+')
25 | parser.add_argument('-o', '--output')
26 | parser.add_argument('-v', '--verbose', action='count')
27 |
28 | args = parser.parse_args()
29 |
30 | if not args.output:
31 | print(f'{sys.argv[0]}: output file not specified')
32 | sys.exit(1)
33 |
34 | # Read and parse input files
35 | print(f'Parsing {len(args.files)} files...')
36 |
37 | all_rows = []
38 |
39 | for filename in args.files:
40 | if not os.path.isfile(filename):
41 | print(f'{sys.argv[0]}: {filename}: not a file')
42 | sys.exit(1)
43 |
44 | with open(filename, 'r', newline='') as csvfile:
45 | reader = csv.DictReader(csvfile, delimiter=',',
46 | quotechar='"', lineterminator='\n')
47 |
48 | for row in reader:
49 | all_rows.append(row)
50 |
51 | # Get BSSIDs from rows
52 | all_row_bssids = []
53 |
54 | for row in all_rows:
55 | all_row_bssids.append(row['bssid'])
56 |
57 | # Search for duplicates
58 | deduped_rows = []
59 | duplicates = 0
60 |
61 | print(f'Merging {len(all_rows)} networks...')
62 |
63 | for i, row in enumerate(all_rows):
64 | if row['bssid'] in all_row_bssids[i + 1:]:
65 |
66 | # Print info if --verbose specified
67 | if args.verbose:
68 | print(f'\033[2K\r{row["bssid"]} ({row["ssid"]}) is a duplicate')
69 |
70 | duplicates += 1
71 | else:
72 | deduped_rows.append(row)
73 |
74 | if args.verbose:
75 | print(end=f'\r\033[1mMerging networks... {i}/{len(all_rows)}, {duplicates} '
76 | 'duplicate(s) found\033[22m',
77 | flush=True)
78 |
79 | if args.verbose:
80 | print('\n\nWriting networks to output...')
81 |
82 | # Write lines to output CSV file
83 | with open(args.output, 'w', newline='') as csvfile:
84 | writer = csv.DictWriter(csvfile, delimiter=',',
85 | quotechar='"', quoting=csv.QUOTE_ALL,
86 | lineterminator='\n', fieldnames=fieldnames)
87 |
88 | writer.writeheader()
89 | writer.writerows(deduped_rows)
90 |
91 | # Print info
92 | print(f'\nMerged {len(all_rows)} networks, of which {duplicates} are duplicate(s).')
93 | print(f'\033[1mTotal: {len(all_rows) - duplicates} networks.\033[22m')
94 |
--------------------------------------------------------------------------------