Public Access
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 roro9stack CI
|
0d67f1a9ec |
-11
@@ -1,11 +0,0 @@
|
||||
.pio/
|
||||
.vscode/
|
||||
*.pyc
|
||||
|
||||
# Private signing keys never belong in the repository (ADR 0003)
|
||||
*key.pem
|
||||
|
||||
# Generated by pioarduino's hybrid compile from custom_sdkconfig (platformio.ini)
|
||||
.dummy/
|
||||
managed_components/
|
||||
sdkconfig.*
|
||||
-164
@@ -1,164 +0,0 @@
|
||||
# roro9stack
|
||||
|
||||
A multi-app handheld operating environment for the M5Stack Cardputer ADV with the Cap LoRa-1262, whose first job is to be a Meshtastic-compatible mesh messenger.
|
||||
|
||||
## Language
|
||||
|
||||
**App**:
|
||||
A foreground, user-facing program chosen from the Launcher. Only one App is on screen at a time; Apps show and act on what Services hold.
|
||||
_Avoid_: program, tool, screen
|
||||
|
||||
**Launcher**:
|
||||
The App that lists every other App and starts them. It's the home screen.
|
||||
_Avoid_: menu, home
|
||||
|
||||
**Service**:
|
||||
A long-lived background capability that keeps running whichever App is in the foreground (e.g. Mesh Service, GNSS Service).
|
||||
_Avoid_: daemon, task, driver
|
||||
|
||||
**Mesh Service**:
|
||||
The Service that keeps the device participating in a mesh network at all times: receiving, relaying, and sending on behalf of Apps.
|
||||
_Avoid_: radio, LoRa app
|
||||
|
||||
**Mesh Protocol**:
|
||||
One on-air language the Mesh Service can speak (Meshtastic first; others may follow). The Mesh Service speaks Mesh Protocols; Apps don't.
|
||||
_Avoid_: stack, mode
|
||||
|
||||
**Node**:
|
||||
Any device participating in the mesh, including this one. It's identified by a node number and has a long and a short name.
|
||||
_Avoid_: peer, device, station
|
||||
|
||||
**Channel**:
|
||||
A named mesh conversation space defined by a name and a shared key. Every Node on the same Channel can read its traffic.
|
||||
_Avoid_: group, room
|
||||
|
||||
**Direct Message**:
|
||||
A text message addressed to a single Node instead of a Channel.
|
||||
_Avoid_: DM (in docs), private message
|
||||
|
||||
**Relaying**:
|
||||
Rebroadcasting another Node's packet so it travels further across the mesh.
|
||||
_Avoid_: forwarding, repeating
|
||||
|
||||
**GNSS Service**:
|
||||
The Service that owns the GNSS receiver on the Cap: it reads its NMEA sentences in the background and holds the current Fix, position, time and satellites.
|
||||
_Avoid_: GPS (GPS is one constellation among several)
|
||||
|
||||
**Fix**:
|
||||
What the receiver currently knows: none, 2D (position without altitude) or 3D (with altitude), from how many satellites, at what HDOP.
|
||||
_Avoid_: lock, signal
|
||||
|
||||
**Track**:
|
||||
A route recorded from GNSS positions to a GPX file on the SD card, started and stopped by the user.
|
||||
_Avoid_: trace, log (a Log is recorded on its own)
|
||||
|
||||
**Wi-Fi Service**:
|
||||
The Service that owns the Wi-Fi radio. It's always in exactly one mode: *Off*, *Connected* (joined to a Saved Network) or *Monitoring* (passively observing). When Wi-Fi is enabled in Settings, it stays Connected whenever a Saved Network is in range. It goes Monitoring only while Wi-Fi Tools needs it, then reconnects.
|
||||
_Avoid_: network manager
|
||||
|
||||
**Saved Network**:
|
||||
A Wi-Fi network the device may join on its own (name, password). When several are in range, the strongest wins.
|
||||
_Avoid_: profile, known network
|
||||
|
||||
**IRC Service**:
|
||||
The Service that keeps the IRC connection alive in the background once the IRC App has started it, until the user stops it (`/quit`, or `irc stop` on the console). Once stopped by hand, opening the App again doesn't reconnect; typing a line does. It reconnects after drops, and pauses while the Wi-Fi Service is Monitoring. It does not start by itself after a reboot.
|
||||
_Avoid_: IRC client (that's the App)
|
||||
|
||||
**Buffer**:
|
||||
One IRC conversation shown in the IRC App: the server, a channel, or a private chat with one nick. Each Buffer counts its unread messages.
|
||||
_Avoid_: window, tab, room
|
||||
|
||||
**Mention**:
|
||||
An IRC message containing the user's nick, or any private message. Mentions raise Notifications; other traffic only counts as unread.
|
||||
_Avoid_: highlight, ping
|
||||
|
||||
**Status Bar**:
|
||||
The strip shown on every screen with system state at a glance: battery, GNSS fix, mesh activity, Wi-Fi mode and unread count.
|
||||
_Avoid_: header, top bar
|
||||
|
||||
**Notification**:
|
||||
News from a Service that reaches the user while another App is in the foreground. It shows as a brief Toast and may beep or flash.
|
||||
_Avoid_: alert, popup
|
||||
|
||||
**Sniffer**:
|
||||
The LoRa Scanner mode that passively listens with the Mesh Service's own radio settings. It never interrupts mesh participation.
|
||||
_Avoid_: monitor (that word belongs to Wi-Fi)
|
||||
|
||||
**Sweep**:
|
||||
The LoRa Scanner mode that takes over the radio to survey frequencies. It pauses the Mesh Service while active.
|
||||
_Avoid_: scan (ambiguous with Wi-Fi scanning)
|
||||
|
||||
**Region**:
|
||||
The regulatory band plan the device transmits under (here EU868). It sets the allowed frequencies, power and duty cycle. Nothing transmits until it has been confirmed.
|
||||
|
||||
**Duty Cycle Budget**:
|
||||
The share of airtime the Region allows this device to transmit. When it's used up, outgoing traffic waits.
|
||||
|
||||
**Text Entry**:
|
||||
When an App is editing text. During Text Entry, `;` `.` `,` `/` type their characters and Fn makes them arrows. Otherwise they are arrows on their own.
|
||||
_Avoid_: edit mode, insert mode
|
||||
|
||||
**Compose Key**:
|
||||
The `opt` key used as a dead key. Pressing it and then a base letter types an accented character (e.g. `opt` `'` `e` → é).
|
||||
_Avoid_: modifier, alt
|
||||
|
||||
**Log**:
|
||||
History the device records automatically in the background: mesh message history, IRC logs, Wi-Fi scan logs.
|
||||
_Avoid_: history file, dump
|
||||
|
||||
**Capture**:
|
||||
Data the user explicitly starts recording, such as Wi-Fi packet captures and LoRa Sniffer captures.
|
||||
_Avoid_: dump, log
|
||||
|
||||
**Storage Warning**:
|
||||
The Notification raised once per boot when the SD card passes 80% full. Selecting it opens Storage Clean-up.
|
||||
|
||||
**Storage Clean-up**:
|
||||
The screen where the user deletes old Logs and Captures by category and age, with a preview of the space freed. Notes are never offered for deletion.
|
||||
|
||||
**Firmware Update**:
|
||||
Installing a new firmware image without a USB cable: pushed over Wi-Fi from the developer's PC, or read from the SD card.
|
||||
_Avoid_: flash, upgrade (alone)
|
||||
|
||||
**Update File**:
|
||||
One signed file (`.ota`) that carries a firmware version, its image and a signature. The same file works over Wi-Fi and from the SD card. Anything not signed with the project's key is refused.
|
||||
_Avoid_: binary, bin
|
||||
|
||||
**Probation**:
|
||||
The state of newly installed firmware until it proves healthy: booted, UI drawn, Services started, 30 s without a crash, and Wi-Fi connected if it's configured. Then it's confirmed for good.
|
||||
_Avoid_: trial, test mode
|
||||
|
||||
**Rollback**:
|
||||
Returning automatically to the previous firmware when new firmware resets or crashes during Probation.
|
||||
_Avoid_: revert, downgrade (a downgrade is installing an older version on purpose)
|
||||
|
||||
**Safe Mode**:
|
||||
What the firmware starts instead of everything else after 3 crash restarts in a row: Wi-Fi and Firmware Updates (and the Debug Console in a Debug Build), so it can be fixed without a cable. A normal restart leaves it.
|
||||
_Avoid_: recovery mode, failsafe
|
||||
|
||||
**Debug Build**:
|
||||
A firmware built with the remote debugging aids compiled in (`+debug` in its version). Release builds have none of them.
|
||||
_Avoid_: dev build, test build (a test build is one made to fail on purpose, such as a crashing update)
|
||||
|
||||
**Debug Console**:
|
||||
The console of a Debug Build over Wi-Fi: live log lines and the serial commands, behind a token.
|
||||
_Avoid_: telnet, remote shell
|
||||
|
||||
## Relationships
|
||||
|
||||
- The **Launcher** starts **Apps**. Exactly one **App** is in the foreground.
|
||||
- **Services** keep running underneath, regardless of which **App** is in the foreground.
|
||||
- The **Mesh Service** speaks one or more **Mesh Protocols** and tracks the known **Nodes**.
|
||||
- The **Wi-Fi Service** is either Connected or Monitoring, never both. Monitoring pauses the **IRC Service**, which reconnects and rejoins its **Buffers** afterwards.
|
||||
- **Services** raise **Notifications**; the **Status Bar** summarises **Service** state.
|
||||
- A **Sweep** pauses the **Mesh Service**; a **Sniffer** does not.
|
||||
- Every transmission is bounded by the **Region** and its **Duty Cycle Budget**.
|
||||
- Past 90% SD usage, **Logs** stop being written; the remaining space is kept for **Captures**. Nothing is deleted without the user's confirmation.
|
||||
- A **Firmware Update** installs an **Update File**; the new firmware runs on **Probation**, and fails back by **Rollback**.
|
||||
- **Rollback** covers new firmware; **Safe Mode** covers confirmed firmware that keeps crashing.
|
||||
- A **Node** may be in several **Channels**. A **Direct Message** targets exactly one **Node**.
|
||||
|
||||
## Flagged ambiguities
|
||||
|
||||
- "LoRa" was used both for the radio and for the mesh. Resolved: say **Mesh Service** for the always-on participation and **Mesh Protocol** for the on-air format. The LoRa Scanner **App** uses the radio directly and doesn't speak a **Mesh Protocol**.
|
||||
- "Channel" has three meanings here. Resolved: an unqualified **Channel** is the mesh one. The others are always qualified as "IRC channel" (a kind of **Buffer**) and "Wi-Fi channel" (radio frequency, 1–13).
|
||||
@@ -1,674 +0,0 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
@@ -1,114 +0,0 @@
|
||||
# roro9stack
|
||||
|
||||
A multi-app firmware for the **M5Stack Cardputer ADV** with the **Cap LoRa-1262**. It's a Meshtastic-compatible mesh messenger, plus Wi-Fi tools, IRC, GNSS and more. Licensed GPL-3.0.
|
||||
|
||||
- Domain language: [CONTEXT.md](CONTEXT.md)
|
||||
- Decisions: [docs/adr/](docs/adr/)
|
||||
- Milestones: [docs/milestones/](docs/milestones/)
|
||||
|
||||
## Requirements
|
||||
|
||||
Only **Docker** is needed. PlatformIO and the ESP32 toolchain run inside a container, and are cached in the `roro9stack-pio` Docker volume. The first build downloads about 1 GB and takes a few minutes.
|
||||
|
||||
## Build and test (local CI)
|
||||
|
||||
```sh
|
||||
scripts/ci.sh
|
||||
```
|
||||
|
||||
This runs the host-side unit tests (`test/`, `native` environment), then builds the firmware. The output is `.pio/build/cardputer-adv/firmware.factory.bin`.
|
||||
|
||||
The framework is rebuilt with the TLS settings in `platformio.ini` (`custom_sdkconfig`, ADR 0006), so the first build after a fresh checkout takes about 4 minutes; later builds take under a minute.
|
||||
|
||||
## Flash
|
||||
|
||||
1. Connect the Cardputer by USB-C.
|
||||
2. Run:
|
||||
|
||||
```sh
|
||||
scripts/flash.sh # auto-detects the port; or: scripts/flash.sh /dev/ttyACM1
|
||||
```
|
||||
|
||||
This uploads the firmware, then opens the serial monitor. Quit the monitor with `Ctrl+C`.
|
||||
|
||||
**If the upload can't connect,** put the device in download mode: hold **G0** (the button next to the screen) while plugging in USB, or while pressing reset. Then retry.
|
||||
|
||||
**If you get "permission denied" on the port,** your user needs access to the serial device. Run this once, then log out and back in:
|
||||
|
||||
```sh
|
||||
sudo usermod -aG dialout "$USER"
|
||||
```
|
||||
|
||||
## Firmware Updates over Wi-Fi (OTA)
|
||||
|
||||
Once the Cardputer runs an OTA-capable firmware (flashed once over USB), updates can go over Wi-Fi:
|
||||
|
||||
```sh
|
||||
scripts/ota_keygen.sh # once: creates the signing key (see ADR 0003)
|
||||
scripts/flash.sh --ota 10.39.39.12 # build, sign and push; or set RORO_OTA_HOST
|
||||
```
|
||||
|
||||
The device shows the push address in **Settings → Firmware**. It installs a correctly signed update right away, restarts (waiting up to 60 s if you're typing), and runs the new firmware on **Probation**. If the new firmware crashes, or can't reconnect Wi-Fi within 3 minutes, it rolls back to the previous one and says so.
|
||||
|
||||
To install from the SD card instead, copy the `.ota` file from `.pio/build/cardputer-adv/` into `/updates` on the card, then use **Settings → Firmware**. With the Cardputer on USB, the card can stay in: `scripts/sd_put.sh <file.ota>` sends it over the serial console into `/updates` (about 30 s for 1.6 MB, checked with SHA-256 before it's renamed into place; `SD_PUT_DEBUG=1` shows the console while it runs).
|
||||
|
||||
**The private key** lives in `~/.config/roro9stack/ota-key.pem` and must never be committed. If it's lost, generate a new pair and flash once over USB.
|
||||
|
||||
## Development aids
|
||||
|
||||
`scripts/serial_log.sh [seconds] [command…]` records the serial output, and can send commands to the firmware first. For example, `scripts/serial_log.sh 30 short sleep:12 burst` sets short screen timeouts, waits 12 s, then sends a burst of Toasts.
|
||||
|
||||
| Command | Effect |
|
||||
|---|---|
|
||||
| `burst` | Publishes 5 Notifications at once |
|
||||
| `key up\|down\|left\|right\|select\|back\|home`, or `key <char>` | Injects a key press |
|
||||
| `sound on` / `sound off` | Toggles the Sound setting (beep + LED) |
|
||||
| `short` / `normal` | Screen timeouts 5 s / 10 s, or 30 s / 60 s |
|
||||
| `wifi add <ssid><TAB><password>` | Adds a Saved Network (so credentials stay out of the repo) |
|
||||
| `log <text>` | Appends a line to a test IRC Log (`/irc/dev/#test/<date>.log`) |
|
||||
| `sd list` | Lists the files of each Storage Clean-up category |
|
||||
| `cat <path>` | Prints the first ~1.2 KB of a file on the SD card |
|
||||
| `irc start` | Starts the IRC Service (normally done by opening the IRC App) |
|
||||
| `irc stop` | Stops it, as `/quit` does: QUIT if connected, no more retries, and the App stays disconnected until you type |
|
||||
| `irc say <buffer> <text>` | Types into a Buffer, commands included (`irc say 0 /join #test`) |
|
||||
| `irc dump` | Prints IRC status, memory, and the last lines of each Buffer |
|
||||
| `wifi status` | Prints Wi-Fi state, network, signal, clock and free heap |
|
||||
| `info` | Firmware, uptime, last start reason, memory, Wi-Fi, and both app slots with their versions and OTA states |
|
||||
| `tasks` | FreeRTOS tasks: state, priority, lowest free stack, CPU share |
|
||||
| `reboot` / `boot other` | Restart, or restart into the other app slot (a manual Rollback) |
|
||||
| `log level <0-5>` | ESP-IDF log level |
|
||||
| `ls [folder]` / `rm <path>` | Lists a folder of the SD card, or deletes a file |
|
||||
| `install <path>` | Update from SD with that `.ota` file, as Settings → Firmware does |
|
||||
| `crash` | The last crash: which firmware, why, task, PC and backtrace (from the core dump in flash) |
|
||||
| `coredump erase` | Forgets the core dump |
|
||||
| `crash abort` / `crash wdt` | Debug Builds: crash on purpose, or hang the main loop until the watchdog fires |
|
||||
| `help` | Lists the commands |
|
||||
|
||||
`scripts/flash.sh` stops a running serial log first, since it would hold the port.
|
||||
|
||||
### Debug Builds and the Debug Console
|
||||
|
||||
`scripts/flash.sh --debug` (USB) or `scripts/flash.sh --debug --ota <ip>` (Wi-Fi) installs a Debug Build: the same firmware plus the Debug Console on TCP 2323 (ADR 0004). Then, with `RORO_OTA_HOST` set to the device's IP:
|
||||
|
||||
```sh
|
||||
scripts/rdbg.py # interactive: the console backlog, live lines, and commands
|
||||
scripts/rdbg.py info # one command and its reply
|
||||
scripts/rdbg.py -b tasks # the same, after the backlog (boot messages and so on)
|
||||
```
|
||||
|
||||
Every command above works there too, plus a few handled by the PC side or the console's own task:
|
||||
|
||||
```sh
|
||||
scripts/rdbg.py crash # the last crash, its backtrace decoded against that exact build's ELF
|
||||
scripts/rdbg.py coredump # fetch the core dump and decode it all (registers, every task) with esp-coredump
|
||||
scripts/rdbg.py reset # restart at once, even if the main loop is stuck
|
||||
scripts/rdbg.py screenshot # the screen as a PNG (2x)
|
||||
scripts/rdbg.py put <file> [card path] # to the SD card (default /updates/<name>), SHA-256 checked, ~300 KB/s
|
||||
scripts/rdbg.py get <card path> [file] # from the SD card
|
||||
```
|
||||
|
||||
So a Firmware Update can also go `rdbg.py put roro9stack-….ota` then `rdbg.py install /updates/roro9stack-….ota`: the Update from SD path, without touching the device.
|
||||
|
||||
Every build keeps its ELF in `.pio/elves/` (version and digest in the name) for that; `scripts/decode_backtrace.sh <version|digest> <addresses>` decodes any backtrace by hand.
|
||||
|
||||
After 3 crash restarts in a row the firmware starts in **Safe Mode** (ADR 0005): only Wi-Fi, Firmware Updates and the Debug Console, so a fix can be pushed as usual. `reboot` leaves it. The token is in `~/.config/roro9stack/debug-token`, made by the first build; keep developing on Debug Builds, so the firmware a Rollback returns to always has the console.
|
||||
@@ -0,0 +1,7 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="117" height="20" role="img" aria-label="lib coverage: 95%">
|
||||
<title>lib coverage: 95% of the lines of lib/ are run by the host tests</title>
|
||||
<linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient>
|
||||
<clipPath id="r"><rect width="117" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)"><rect width="84" height="20" fill="#555"/><rect x="84" width="33" height="20" fill="#4c1"/><rect width="117" height="20" fill="url(#s)"/></g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="42.0" y="14">lib coverage</text><text x="100.5" y="14">95%</text></g></svg>
|
||||
|
After Width: | Height: | Size: 768 B |
@@ -1,7 +0,0 @@
|
||||
# Name, Type, SubType, Offset, Size, Flags
|
||||
nvs, data, nvs, 0x9000, 0x5000,
|
||||
otadata, data, ota, 0xe000, 0x2000,
|
||||
app0, app, ota_0, 0x10000, 0x330000,
|
||||
app1, app, ota_1, 0x340000,0x330000,
|
||||
spiffs, data, spiffs, 0x670000,0x180000,
|
||||
coredump, data, coredump,0x7F0000,0x10000,
|
||||
|
@@ -1,13 +0,0 @@
|
||||
# Build/test/flash environment for roro9stack. No toolchain needed on the host.
|
||||
FROM python:3.12-slim
|
||||
|
||||
RUN apt-get update \
|
||||
&& apt-get install -y --no-install-recommends git build-essential \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
RUN pip install --no-cache-dir platformio
|
||||
|
||||
# Toolchains and libraries are cached in a named volume mounted here.
|
||||
RUN mkdir -p /pio && chmod 777 /pio
|
||||
ENV PLATFORMIO_CORE_DIR=/pio
|
||||
WORKDIR /work
|
||||
@@ -1,15 +0,0 @@
|
||||
# Own firmware that speaks Meshtastic, not a Meshtastic fork
|
||||
|
||||
We build our own firmware from existing libraries (PlatformIO + Arduino-ESP32, M5Cardputer/M5Unified, RadioLib, TinyGPSPlus, nanopb with Meshtastic's published protobufs). We implement the Meshtastic protocol ourselves as one pluggable Mesh Protocol, rather than forking the Meshtastic firmware, which already supports this exact hardware.
|
||||
|
||||
A fork would give full compatibility on day one, but its architecture is built around being a single-purpose Meshtastic node. That conflicts with our goals: a multi-app OS with a fully custom UX, and room for other mesh protocols (e.g. MeshCore) later.
|
||||
|
||||
## Consequences
|
||||
|
||||
- We accept partial Meshtastic compatibility at first: text on channels, Direct Messages, node list, position and relaying.
|
||||
- The phone-app (BLE) API and PKI-encrypted Direct Messages are deferred, and we must re-implement protocol details ourselves.
|
||||
- Multi-boot with stock Meshtastic via a launcher was rejected: it gives none of our own UX.
|
||||
|
||||
## Note (2026-10-04, M2)
|
||||
|
||||
NMEA is parsed by our own small, host-tested parser instead of TinyGPSPlus: the GNSS App's Sky view needs the satellite list (GSV) across several constellations, which TinyGPSPlus doesn't track. See docs/milestones/M2.md, Q66.
|
||||
@@ -1,10 +0,0 @@
|
||||
# Own small widget kit on M5GFX, not LVGL
|
||||
|
||||
The UI is drawn with M5GFX into an off-screen buffer, using a small widget kit we own: list, text view, line editor, dialog, Status Bar and Toast. We chose this over LVGL.
|
||||
|
||||
LVGL would give us ready-made widgets, but it costs roughly 40–60 KB of RAM on a device with no PSRAM. It would also need to coexist with the Mesh Service, the Wi-Fi stack and TLS, and it brings a large learning surface. Most of our Apps are lists and text on a 240×135 screen, and full control of the UX is a primary goal.
|
||||
|
||||
## Consequences
|
||||
|
||||
- We write and maintain our own widgets.
|
||||
- Switching to LVGL later would mean rewriting every App's view layer.
|
||||
@@ -1,12 +0,0 @@
|
||||
# Signed Update Files checked by the firmware, not ESP32 Secure Boot
|
||||
|
||||
Firmware Updates are accepted only when their Update File carries a valid ECDSA P-256 signature over the image's SHA-256. The firmware itself checks it, against a public key compiled into it, before switching the boot partition. The private key lives outside the repository, in `~/.config/roro9stack/ota-key.pem`.
|
||||
|
||||
We chose this over the ESP32's hardware Secure Boot. Secure Boot is enforced by the chip, but it burns eFuses one-way: a mistake bricks the device, and the device can never run unsigned firmware again, which makes recovery over USB harder. On a single development device, a software check that refuses unsigned pushes is enough, and it stays reversible: a new firmware can carry a new public key.
|
||||
|
||||
## Consequences
|
||||
|
||||
- Someone with physical USB access can still flash anything. Only Wi-Fi and SD card updates are guarded.
|
||||
- **Losing the private key** means the next update has to go over USB, carrying a new public key.
|
||||
- P-256 rather than Ed25519, because the firmware's TLS library (mbedTLS) already verifies it, so it costs no extra code.
|
||||
- **Rollback: the bootloader first, the firmware as a second line.** Arduino-ESP32 marks a new image valid before `setup()` unless the sketch overrides `verifyRollbackLater()`, which once made every update look good and hid the bootloader's rollback (it had looked like the prebuilt bootloader ignored it). With the override, an image stays pending until Probation confirms it, and the bootloader reverts one that restarts unconfirmed, however early it crashes. The firmware also counts its own boots on Probation, very first thing in `setup()`, and reverts itself on the second unconfirmed start.
|
||||
@@ -1,23 +0,0 @@
|
||||
# A Debug Console over Wi-Fi, in Debug Builds only
|
||||
|
||||
The goal of Firmware Updates is to manage the device without a cable, and that includes finding out what went wrong. So a **Debug Build** (`cardputer-adv-debug`, `-DRORO_DEBUG`, version suffix `+debug`) adds a **Debug Console** on TCP 2323: the serial console, over Wi-Fi. A client sends a token as its first line, then gets the last 4 KB of console output (boot messages included), every new line live, and runs the same commands as the serial port, plus a few that only make sense remotely. ESP-IDF's own log lines are teed into it.
|
||||
|
||||
It's compiled out of release builds entirely, rather than switched off by a setting. A console that runs commands is a remote control: in a release build, nothing listens.
|
||||
|
||||
## How it fits
|
||||
|
||||
- **Console, not Serial.** All human-readable output goes through `console`, which writes to the USB port and, in a Debug Build, to a ring buffer the Debug Console drains. Writes never wait for USB: a host that's attached but not reading used to stall the main loop for up to 2 s per line.
|
||||
- **Commands run on the main loop.** The socket lives on the Debug Console's own task, which only queues command lines. The main loop runs them, as it does serial commands, so they touch Apps and Services from the one task allowed to.
|
||||
- **The token** is 128 random bits in `~/.config/roro9stack/debug-token`, made by the first build and passed into the container. It's never committed; a Debug Build refuses to compile without one. Like the OTA key, it guards against the network, not against someone holding the device.
|
||||
- **One client at a time**, to keep memory flat (4 KB for the ring since M2, 6 KB of task stack).
|
||||
- **Binary commands are answered on the console's own task**, not queued: `get`/`put` (SD card files, run as one Storage Service job each so card access stays on the storage task, with TCP doing the flow control), `screenshot` (the 32 KB RGB332 frame the UI composes into, read as it stands, so it may tear), `coredump get` and `reset`. These keep working when the main loop is stuck. A failed `put` closes the connection, so the rest of the file is never read as commands.
|
||||
|
||||
## Keep a Debug Build in the fallback slot
|
||||
|
||||
Rollback returns to the previous firmware, whatever it is. As long as development goes through Debug Builds, the firmware a crash falls back to has the Debug Console, so a bad update never costs remote access. A release build pushed over a Debug Build leaves the Debug Build in the other slot until the next update overwrites it.
|
||||
|
||||
## Consequences
|
||||
|
||||
- Anyone on the same network with the token can read the console, inject keys and reboot the device. The console never prints stored secrets (Wi-Fi and IRC passwords), but the IRC traffic it shows is readable.
|
||||
- The TCP stream is plain text: fine on a home network, not across the internet.
|
||||
- `+debug` versions compare equal to their release counterparts, so moving between the two is never refused as a downgrade.
|
||||
@@ -1,13 +0,0 @@
|
||||
# Safe Mode, crash reports and a watched main loop, in every build
|
||||
|
||||
Rollback protects against new firmware that fails Probation. It does nothing for firmware that was confirmed and crashes later: a corrupt setting, a server that sends something unexpected, a bug that takes an hour to show. Without a cable, such a device would restart forever. Three measures, in release and Debug Builds alike, keep it reachable:
|
||||
|
||||
- **Safe Mode.** The firmware counts starts that follow a crash (panic or watchdog) in NVS, first thing at boot. After 3 in a row, it starts only the clock, Wi-Fi, the Update Service and, in a Debug Build, the Debug Console: no Apps, no IRC, no SD card, and a screen that says so with the address to push an update to. Any normal restart (a `reboot`, an update), or a minute of uptime, resets the count.
|
||||
- **Crash reports.** The same boot record keeps which version was running, so after a crash the firmware knows which one crashed, even when a Rollback has switched slots since. ESP-IDF already writes a core dump to its flash partition on a panic; after the restart the firmware prints its summary (task, PC, reason, backtrace) and raises a Notification. The `crash` command shows it again later. In a Debug Build, `scripts/rdbg.py crash` decodes the backtrace and `scripts/rdbg.py coredump` fetches the whole dump for `esp-coredump`, against the ELF of that exact build (`.pio/elves/`, named by version and ELF digest).
|
||||
- **The main loop is watched.** Arduino-ESP32 subscribes only core 0's idle task to the task watchdog, and the main loop runs on core 1: a stuck loop used to hang the device for good, with the screen frozen and the Debug Console unable to run commands. `enableLoopWDT()` makes a loop stuck for 5 s a panic, with a core dump, counted towards Safe Mode. And an installed update no longer depends on the main loop: the Update Service restarts into it by itself after 90 s.
|
||||
|
||||
## Consequences
|
||||
|
||||
- Nothing in the main loop may block for 5 s. Network and card work already run on their own tasks.
|
||||
- Safe Mode can't help when Wi-Fi or the Update Service itself is what crashes; that still needs USB.
|
||||
- Three crashes within a minute of each restart are needed to reach Safe Mode, so a crash loop costs about half a minute before the device becomes reachable.
|
||||
@@ -1,19 +0,0 @@
|
||||
# The framework is rebuilt with our own SDK settings, for smaller TLS buffers
|
||||
|
||||
Arduino-ESP32 ships its ESP-IDF libraries prebuilt, with one `sdkconfig` for every ESP32-S3 board. Its TLS settings give every connection a 16 KB receive buffer and a 16 KB send buffer for its whole life. On a device with no PSRAM and about 340 KB of RAM, an IRC connection over TLS left a 12.6 KB low in M2, against a 40 KB floor.
|
||||
|
||||
Those settings are compiled into the libraries, so changing them means rebuilding them. pioarduino supports this as a "hybrid compile": `custom_sdkconfig` in `platformio.ini` lists the settings, and the build regenerates the framework's libraries from ESP-IDF (the same 5.5.5 the prebuilt ones come from) before building the app. We set:
|
||||
|
||||
- `MBEDTLS_ASYMMETRIC_CONTENT_LEN`, with 16 KB to receive (servers send full TLS records) and **4 KB to send** (IRC lines are short): 12 KB less per connection.
|
||||
- `MBEDTLS_DYNAMIC_BUFFER`, `DYNAMIC_FREE_CONFIG_DATA`, `DYNAMIC_FREE_CA_CERT`: buffers allocated when needed, and handshake-only data (the CA chain) freed once connected.
|
||||
|
||||
The rebuild also follows the board definition instead of the generic one: PSRAM support is off (the Cardputer ADV has none) and the flash size is 8 MB.
|
||||
|
||||
## Consequences
|
||||
|
||||
- With IRC connected over TLS, a Debug Build has 78 KB free and a 59 KB low (it was 31 KB and 12.6 KB), and 46 KB at the lowest under the heaviest combined load measured (IRC, two refused installs, a 1.6 MB put and get).
|
||||
- The first build after a fresh checkout, or after changing `custom_sdkconfig`, takes about 4 minutes instead of 45 s: it downloads ESP-IDF into the PlatformIO volume and compiles it. Later builds reuse it.
|
||||
- Everything the firmware depends on was checked in the regenerated `sdkconfig`: app rollback, core dumps to flash (ELF), the 5 s task watchdog, FreeRTOS run-time stats, the certificate bundle.
|
||||
- The project now owns its partition table (`default_8MB.csv`, identical to the framework's), which the hybrid build requires. Changing it would break updates over the air: the app slots must stay where they are.
|
||||
- Generated files (`sdkconfig.*`, `managed_components/`, `.dummy/`) are ignored by git.
|
||||
- A TLS server that sends records over 16 KB would still fail, as before; one that needs us to send records over 4 KB would now fail. Neither happens with IRC.
|
||||
@@ -1,89 +0,0 @@
|
||||
# M0 — Skeleton: Launcher, Status Bar, Settings, battery
|
||||
|
||||
**Status:** done on 2026-10-02, tagged `v0.1.0`.
|
||||
|
||||
## Outcome
|
||||
|
||||
Every "Done when" item below works on the device, apart from the gaps listed here. Changes made along the way:
|
||||
|
||||
- **Not done, carried over:**
|
||||
- **Charging indicator:** the battery voltage alone can't tell charging apart reliably. Revisit if the hardware exposes a charger status.
|
||||
- **Waking from power-off with a keyboard key:** G0 only for now.
|
||||
- **Status Bar placeholders** for GNSS, mesh, Wi-Fi and unread count are left out until those Services exist (M1, M2, M4).
|
||||
- **Added:**
|
||||
- **SD card erase**, in Settings → Storage.
|
||||
- **A Notification wakes an Off screen** (dimmed) while its Toast shows.
|
||||
- **Navigation arrows without Fn** outside Text Entry.
|
||||
- **Serial dev commands** and `scripts/serial_log.sh`.
|
||||
- **Measured on the device:**
|
||||
- About 225 KB free heap with the 64 KB frame buffer.
|
||||
- About 15 ms per frame.
|
||||
- 19% of the app flash used.
|
||||
|
||||
**Goal:** a firmware you can flash and hold. It boots to a Launcher, shows a live Status Bar, navigates with the keyboard and saves Settings. It proves the App/Service architecture that every later milestone plugs into.
|
||||
|
||||
## Done when
|
||||
|
||||
- Building, testing and flashing each work with one command, run inside a local Docker container (no toolchain on the host).
|
||||
- First boot runs the setup wizard (names, Region, timezone), and later boots skip it.
|
||||
- The Launcher lists Apps. Enter starts one, `` ` `` goes back, and Fn+`` ` `` returns home from anywhere.
|
||||
- The Status Bar shows battery %, a charging indicator and the clock (relative until set), with placeholders for GNSS, mesh, Wi-Fi and unread count.
|
||||
- The Settings App edits and persists: long and short name, Region, timezone, brightness, dim and off timeouts, sound on/off, and probe-request MAC handling (raw by default).
|
||||
- An About screen shows the version, free heap, battery voltage, SD status and usage, and uptime.
|
||||
- The screen dims at 30 s and turns off at 60 s. Any key wakes it without the key also acting on the App.
|
||||
- A long press of G0 powers off (deep sleep). G0 or a key wakes the device.
|
||||
- The Compose Key types accented characters in the line editor (`opt` `'` `e` → é).
|
||||
- Toast Notifications work. A demo App can raise one, with a beep and LED flash.
|
||||
- SD usage is watched: a Storage Warning appears once per boot above 80%. The Log-write cutoff flag is set at 90%, with no Log writers yet.
|
||||
|
||||
## Out of scope for M0
|
||||
|
||||
Storage Clean-up screen (M1, once IRC Logs exist), any radio, GNSS, Wi-Fi.
|
||||
|
||||
## Work breakdown
|
||||
|
||||
1. **Project scaffold**
|
||||
- PlatformIO project with the pioarduino platform (Arduino-ESP32 3.x on ESP-IDF 5.x). Board `m5stack-stamps3`, 8 MB partitions, USB-CDC on boot.
|
||||
- Dependencies: `M5Cardputer` (pulls in M5Unified and M5GFX).
|
||||
- `LICENSE` (GPL-3.0), `README.md` with build and flash steps, a version string injected from git at build time (semver tags).
|
||||
- A `native` environment for host-side unit tests (Unity).
|
||||
- **Local CI** in a Docker image with PlatformIO. One script builds the firmware and runs the native tests, and the same container flashes over USB. The repo is hosted on self-hosted Gitea, and a Gitea Actions workflow can reuse this image later.
|
||||
2. **Hardware bring-up checks** (manual, on the device)
|
||||
- Display, keyboard (TCA8418) and speaker through M5Cardputer.
|
||||
- Confirm there's no PSRAM, and record the heap at boot.
|
||||
- Investigate the G38 backlight/LED power-rail coupling, then decide how dimming works without killing the LED.
|
||||
- Battery ADC on G10 (×2 divider): calibrate the voltage-to-% curve.
|
||||
- SD card mount on the shared SPI bus (CS=12), behind a bus lock ready for the LoRa radio in M3.
|
||||
3. **Core runtime**
|
||||
- **Event bus:** Services publish events (battery changed, notification, storage threshold), and the UI consumes them on the UI task.
|
||||
- **Service interface:** start, stop, periodic tick, state snapshot for the Status Bar.
|
||||
- **App interface:** enter, exit, key event, draw. Plus a registry, so adding an App means one file and one registration line.
|
||||
- **App lifecycle:** one foreground App; Home and Back handling.
|
||||
4. **Services for M0**
|
||||
- **Settings store:** typed keys in NVS (internal flash), with defaults and change events.
|
||||
- **Battery Service:** sampled voltage, smoothed %, charging detection if the hardware allows it.
|
||||
- **Clock Service:** no time source yet. API for "set from source X", plus relative-time formatting and Europe/Brussels conversion.
|
||||
- **Storage Service:** SD present/absent, usage %, 80% and 90% thresholds raising events, Log-write permission flag.
|
||||
- **Power Service:** dim and off timers, wake-key swallowing, G0 long-press → deep sleep.
|
||||
5. **Widget kit** (ADR 0002): an off-screen buffer pushed to the display.
|
||||
- Status Bar, list, text view, line editor (with the Compose Key), dialog and Toast.
|
||||
- A Latin-1 font set.
|
||||
6. **Input layer**
|
||||
- Map key events to logical keys: arrows (Fn + `;` `.` `,` `/`), Back, Home, Select.
|
||||
- Compose Key dead-key state machine. This is pure logic, unit-tested on the host.
|
||||
7. **Apps:** Launcher, Settings (including About), first-boot wizard, and a hidden Demo App for exercising Toasts and widgets.
|
||||
8. **Docs:** a short walkthrough for a first-time setup: install PlatformIO, USB permissions on Linux, flash, recover via download mode.
|
||||
|
||||
## Host-tested logic (TDD candidates)
|
||||
|
||||
- Compose Key state machine
|
||||
- Battery voltage → % curve and smoothing
|
||||
- Storage threshold and once-per-boot warning logic
|
||||
- Relative-time formatting and timezone conversion
|
||||
- Settings defaults and validation (e.g. Region must be confirmed before any transmit flag)
|
||||
|
||||
## Risks to resolve early
|
||||
|
||||
- **G38 shared rail:** if the backlight and LED really share power, "screen off" may also need to turn the LED off.
|
||||
- **RAM headroom:** the off-screen buffer is 240×135×2 ≈ 64 KB at 16-bit, or about 32 KB at 8-bit. Measure the free heap now, because Wi-Fi + TLS (M1) is the tightest point.
|
||||
- **Keyboard library maturity** for the ADV's TCA8418 in `M5Cardputer`. Fall back to Adafruit_TCA8418 directly if needed.
|
||||
@@ -1,70 +0,0 @@
|
||||
# M1 — Wi-Fi Service, Wi-Fi Tools, IRC
|
||||
|
||||
**Status:** done on 2026-10-03, tagged `v0.2.0`.
|
||||
|
||||
## Outcome
|
||||
|
||||
The "Done when" items below work on the device, against irc.libera.chat over TLS, with the following changes.
|
||||
|
||||
- **Changed:**
|
||||
- **Wi-Fi Tools is built from ordinary scans only:** networks nearby, channel occupancy and a signal tracker. Monitoring-mode views and captures are deferred (revised Q42). The Monitoring mode stays in the Wi-Fi Service and the IRC pause logic, unused for now.
|
||||
- **The frame buffer is 8-bit colour** (Q46), applied as soon as IRC on TLS measured a 51 KB low.
|
||||
- **Not done, carried over:**
|
||||
- **Wi-Fi scan logs** (a CSV of the access points each scan sees) can be recorded from Wi-Fi Tools; monitoring-mode captures remain deferred.
|
||||
- **IRC has no input history** (up-arrow recall). Each Buffer keeps only 50 lines in RAM; the full history is in the Logs.
|
||||
- **Measured on the device:**
|
||||
- With Wi-Fi and IRC on TLS: about 92 KB free heap, about 77–81 KB at the lowest. The floor was 40 KB.
|
||||
- 44% of the app flash used.
|
||||
- 231 host tests.
|
||||
|
||||
**Goal:** the device joins your Wi-Fi by itself, syncs its clock, keeps an IRC session alive in the background, and gives passive Wi-Fi diagnostics with full-frame captures.
|
||||
|
||||
## Decisions (design round 2026-10-02)
|
||||
|
||||
| # | Decision |
|
||||
|---|---|
|
||||
| Q40 | Up to 8 **Saved Networks**, joined strongest-first. Added from a scan or as a hidden network. Open networks are allowed; enterprise (802.1X) is not. |
|
||||
| Q41 / Q48 | The Wi-Fi Service stays **Connected** whenever enabled and a Saved Network is in range. Settings has a Wi-Fi On/Off switch. **Monitoring** happens only while Wi-Fi Tools is open; the device reconnects on exit. |
|
||||
| Q42 | *Revised 2026-10-02:* Wi-Fi Tools is built from ordinary scans only (access points, channel occupancy, signal tracker). Monitoring-mode views and captures are deferred, to be revisited later. |
|
||||
| Q43 | The signal tracker clicks faster as the signal gets stronger. On by default, mutable. |
|
||||
| Q44 | IRC shows one Buffer at a time; Tab cycles Buffers. Commands: `/join /part /msg /me /nick /topic /names /quit /raw`. Logs go to `/irc/<network>/<buffer>/YYYY-MM-DD.log`. |
|
||||
| Q45 | TLS verifies server certificates against the bundled certificate authorities. Per server, a self-signed certificate can be pinned on first use. |
|
||||
| Q46 | If RAM is short: switch the frame buffer to 8-bit colour. Keep the AtomS3 Wi-Fi co-processor in mind. |
|
||||
| Q47 | Passwords are stored in NVS without flash encryption (revisit before any public release). |
|
||||
| IRC | The **IRC Service** stays connected in the background once the App has started it, until `/quit` or disconnect. It does not start at boot. |
|
||||
| Q49 | Opening a Monitoring view while IRC is connected asks first. IRC then pauses, and reconnects and rejoins afterwards; its Buffers show the gap. |
|
||||
| Q50 | Reconnects after drops wait 5 s, 10 s, 30 s … up to 5 min. |
|
||||
| Q51 | Mentions and private messages raise Notifications. Other traffic only counts as unread (Status Bar shows the total). |
|
||||
| M0 | The **Storage Clean-up** screen lands here, once IRC Logs and Captures exist. |
|
||||
|
||||
## Done when
|
||||
|
||||
- Wi-Fi joins the strongest Saved Network at boot. The Status Bar shows Wi-Fi state, and the clock is set over NTP.
|
||||
- Settings → Wi-Fi: On/Off, scan and add a network (with password), add a hidden network, forget a network.
|
||||
- The IRC App configures one server (host, port, TLS, nick, SASL or NickServ, auto-join IRC channels). It connects and keeps running after you leave the App. Mentions notify.
|
||||
- IRC reconnects after Wi-Fi loss or a server drop, and rejoins its IRC channels. Logs are written to the SD card (and stop past 90% usage).
|
||||
- Wi-Fi Tools: access-point list, channel occupancy with the quietest of channels 1/6/11, and a signal tracker that clicks faster as the signal gets stronger. None of it interrupts the connection or IRC.
|
||||
- Settings → Storage → Clean-up deletes IRC Logs, probe Logs and Wi-Fi Captures older than a chosen age, with a preview of the space freed.
|
||||
- Free heap stays above about 40 KB with Wi-Fi, TLS-connected IRC and the UI running.
|
||||
|
||||
## Work breakdown (proposed order)
|
||||
|
||||
1. **Memory baseline:** measure the heap with Wi-Fi Connected plus one TLS connection. Switch the frame buffer to 8-bit if the margin is too thin.
|
||||
2. **Wi-Fi Service:**
|
||||
- Saved Networks in NVS.
|
||||
- Choosing the network (host-tested).
|
||||
- The Off / Connecting / Connected / Monitoring state machine (host-tested).
|
||||
- NTP → Clock.
|
||||
- Status Bar indicator.
|
||||
- Settings → Wi-Fi pages.
|
||||
3. **Log writing:** a Log writer that respects the Storage rules, daily files, and the Storage Clean-up screen (selection logic host-tested).
|
||||
4. **IRC Service** (host-tested core):
|
||||
- message parser and serializer;
|
||||
- registration, SASL PLAIN and NickServ;
|
||||
- PING/PONG;
|
||||
- Buffers with unread counts and Mention detection;
|
||||
- reconnect backoff, and pause/resume around Monitoring.
|
||||
|
||||
Then the TLS transport with the certificate bundle.
|
||||
5. **IRC App:** Buffer view, input line, command parser (host-tested), server settings page.
|
||||
6. **Wi-Fi Tools App:** access-point list, channel occupancy and signal tracker from scans (occupancy and tracker logic host-tested). Monitoring mode is deferred.
|
||||
@@ -1,59 +0,0 @@
|
||||
# M2 — GNSS
|
||||
|
||||
**Status:** done on the device (branch `m2`): every "Done when" item below is met.
|
||||
|
||||
## Measured
|
||||
|
||||
- **Cold start** (`$PCAS10,2`) to a 3D Fix, by a window: **73 s**, 5 satellites used of 8 in view. A restart of the ESP32 alone keeps the receiver's Fix (the Cap stays powered).
|
||||
- By a window: 3D Fix from GPS, GLONASS, Galileo and BeiDou, up to 14 of 17 satellites used, HDOP 1.0–1.3.
|
||||
- **Heap, Debug Build, GNSS on, IRC on TLS** (floor 40 KB; v0.2.1 had a 79 KB low):
|
||||
|
||||
| | Free | Lowest |
|
||||
|---|---|---|
|
||||
| Start of M2 | 31 KB | 12.6 KB |
|
||||
| Stacks and buffers trimmed by measurement | 46 KB | 18 KB |
|
||||
| mDNS removed | 54 KB | 34 KB |
|
||||
| Framework rebuilt with smaller TLS buffers (ADR 0006) | **78 KB** | **59 KB** |
|
||||
|
||||
Under the heaviest combined load measured (IRC, two refused installs, a 1.6 MB put and get), the low is 46 KB. The cost had come mostly from the OTA and Debug Build work, not GNSS. Stacks were set to measured peak plus about 2 KB (loop 6 KB, update 5, storage 6, irc 6); after a TLS handshake the irc task has 1.7 KB left. IRC can now be stopped by hand (`/quit` in any state, `irc stop`), which frees its TLS memory.
|
||||
|
||||
**Goal:** the device knows where it is and what time it is without a network: a GNSS Service in the background, a GNSS App with the position and a sky view of the satellites, the clock set from satellites when there's no NTP, and Tracks recorded to the SD card.
|
||||
|
||||
**Hardware:** the Cap LoRa-1262 carries an ATGM336H-6N (AT6668), multi-constellation (GPS, BeiDou, Galileo, GLONASS, QZSS), with a ceramic antenna. NMEA over UART, 115200 8N1. **Measured (step 1, `gnss probe`): RX GPIO 15, TX GPIO 13, 115200 8N1**, as in Meshtastic's board file; M5Stack's page names GPIO 8 and 9, which are the internal I2C bus the keyboard controller sits on. Output is NMEA 4.10 style: `GN` RMC, VTG and GGA, one GSA per constellation with the system ID (1 GPS, 2 GLONASS, 3 Galileo, 4 BeiDou, 5 QZSS) in its last field, and a GSV sequence per constellation and signal (`GP`, `GL`, `GA`, …) with the signal ID last. RMC carries a time even without a Fix (status `V`), so only a Fix makes it trustworthy.
|
||||
|
||||
## Decisions (design round 2026-10-04)
|
||||
|
||||
| # | Decision |
|
||||
|---|---|
|
||||
| Q58 | Settings has a GNSS On/Off switch, **On by default**. Off puts the receiver in standby. *Measured:* `$PCAS12,<seconds>` (CASIC) stops its output within a second, for up to at least 65535 s, and any command wakes it within a second; Off sends `PCAS12,65535` (renewed hourly), On sends a hot start, `PCAS10,0`. |
|
||||
| Q59 | The **GNSS App** has two views, switched with Tab. *Position*: latitude, longitude, altitude, speed, course, Fix (none / 2D / 3D), satellites used and in view, HDOP, UTC time. *Sky*: the satellites placed by azimuth and elevation, coloured by constellation, filled when used in the Fix. |
|
||||
| Q60 | "Radar" in M2 means the Sky view. A radar of other Nodes by distance and bearing needs the mesh: M4. |
|
||||
| Q61 | The **Status Bar** shows a GNSS mark: absent when off, muted while searching, normal with a 2D Fix, with the satellite count with a 3D Fix. |
|
||||
| Q62 | GNSS time **sets the clock once there's a Fix**, and refreshes it every 10 minutes. *Revised in step 3:* the clock's trust order from M0 (Mesh < NTP < GNSS) already ranks GNSS above NTP, which is right: GNSS time is at least as accurate. So GNSS also corrects a clock NTP set, not only an unset one. |
|
||||
| Q63 | A **Track** is started and stopped in the GNSS App. It's written as GPX to `/gnss/tracks/<YYYYMMDD-HHMMSS>.gpx`, a point every 5 s when the position moved more than 5 m. It keeps recording with the App closed, with a Toast on start and stop and a Status Bar mark, and gets its own Storage Clean-up category. |
|
||||
| Q64 | Coordinates in **decimal degrees plus the Maidenhead locator**; a Settings switch for degrees, minutes and seconds. Metric units only. |
|
||||
| Q65 | **The position never leaves the device in M2.** Sharing it over the mesh, and at what precision, is decided in M4. |
|
||||
| Q66 | **Our own NMEA parser**, host-tested: RMC, GGA, GSA and GSV, with each talker ID mapped to its constellation. TinyGPSPlus (named in ADR 0001) doesn't track the satellite list across constellations, which the Sky view needs. |
|
||||
| Q67 | The receiver keeps its **defaults** (all constellations, 1 Hz). No receiver settings. Time to first fix is measured and recorded here. |
|
||||
| Q68 | Debug aids: `gnss status`, and `gnss nmea on/off` to stream the raw sentences to the console (USB serial and Debug Console). Raw NMEA is never written to the card. |
|
||||
|
||||
**Lesson (step 3):** the first probe also tried the pins swapped, driving the receiver's output line from the ESP32 for about a second. The receiver then went silent until a full power cycle (an ESP32 restart doesn't cut the Cap's power). Never drive GPIO 15.
|
||||
|
||||
## Done when
|
||||
|
||||
- The GNSS Service reads NMEA in the background whatever App is on screen, and a 3D Fix appears outdoors.
|
||||
- The GNSS App shows the Position and Sky views, both live.
|
||||
- The Status Bar shows the GNSS mark per Q61.
|
||||
- With no Wi-Fi, the clock is set from GNSS after the first Fix.
|
||||
- A Track records while the App is closed, survives the screen turning off, and opens as valid GPX on the PC.
|
||||
- Settings → GNSS Off stops it (and the Status Bar mark goes away); On brings it back.
|
||||
- Free heap stays above about 40 KB with GNSS, Wi-Fi, IRC on TLS and the UI running.
|
||||
|
||||
## Work breakdown
|
||||
|
||||
1. **Hardware check:** a `gnss probe` command reads the candidate UART pins and reports which carries NMEA, at what baud rate, and which talker IDs. Then the standby command (Q58) and a first time to first fix.
|
||||
2. **NMEA parser** (host-tested): checksum, RMC, GGA, GSA, GSV across constellations, merged into one GNSS state (Fix, position, time, satellites).
|
||||
3. **GNSS Service:** UART on its own task, the parser, `gnss status` and `gnss nmea`, Settings On/Off.
|
||||
4. **Clock from GNSS** (Q62), and the Status Bar mark (Q61).
|
||||
5. **GNSS App:** Position view, Maidenhead and coordinate formats (host-tested), then the Sky view.
|
||||
6. **Tracks:** the 5 s / 5 m rule and GPX writing (host-tested), background recording, Clean-up category.
|
||||
@@ -1,33 +0,0 @@
|
||||
# OTA — Firmware Updates over Wi-Fi and from the SD card
|
||||
|
||||
**Goal:** install new firmware without a USB cable. Push it from the PC over Wi-Fi, or drop it on the SD card. Unsigned images are refused, and a broken update rolls back by itself.
|
||||
|
||||
## Decisions (design round 2026-10-03)
|
||||
|
||||
| # | Decision |
|
||||
|---|---|
|
||||
| Q52 | Two sources: **push over Wi-Fi** from the PC, and **from the SD card**. Pulling from Gitea releases is deferred. |
|
||||
| Q53 | **Signed Update Files** (ECDSA P-256 over SHA-256). The private key stays in `~/.config/roro9stack/`, and the firmware embeds the public key (ADR 0003). |
|
||||
| Q54 | The device **always listens** for pushes on the LAN while Wi-Fi is Connected. *Revised in M2:* it was announced over mDNS as `roro9stack-<id>.local`; mDNS was removed to save RAM (it never crossed the dev box's routed network anyway). Pushes go to the IP shown in Settings → Firmware. |
|
||||
| Q55 | New firmware runs on **Probation**. It's confirmed once booted, UI drawn, Services started, 30 s without a crash, and Wi-Fi connected (if configured). Otherwise **Rollback**. A Toast reports either outcome. |
|
||||
| Q56 | **Downgrades are allowed**, with "older than the installed version" shown. |
|
||||
| Q57 | A valid push **installs right away**: progress screen, then reboot. The reboot waits for Text Entry to end, 60 s at most. |
|
||||
|
||||
## Done when
|
||||
|
||||
- `scripts/ota_keygen.sh` creates the key pair once. The public key is committed; the private key never is.
|
||||
- `scripts/flash.sh --ota` builds, signs and pushes to `roro9stack-<id>.local`. The device shows progress, reboots, and a Toast confirms the new version.
|
||||
- An Update File with a bad signature, a truncated or corrupted image, or no signature is refused, and the device keeps running.
|
||||
- Settings → About → **Update from SD** lists the `.ota` files in `/updates` and installs one.
|
||||
- A firmware that crashes during Probation rolls back to the previous version, and says so after the reboot.
|
||||
|
||||
## Work breakdown
|
||||
|
||||
1. **Update File format** (host-tested): header (magic, format, version, image size, SHA-256), signature, image. A streaming parser that hashes as it goes and decides accept / refuse / downgrade. The signature verifier sits behind an interface, so tests can inject one.
|
||||
2. **PC side:** key generation, `make_ota.py` (wraps `firmware.bin` into a signed `.ota`), and the push client. `flash.sh --ota` ties them together.
|
||||
3. **Device:** the Update Service.
|
||||
- A listener on TCP 3232 plus mDNS.
|
||||
- Writes the image to the inactive app slot, with the ECDSA check through mbedTLS.
|
||||
- A progress screen, and a reboot that waits out Text Entry.
|
||||
4. **Probation and Rollback:** the health checks, confirming the image, and detecting a rollback after reboot to report it.
|
||||
5. **Update from SD:** the same parser, fed from the Storage Service's task (all card access stays there).
|
||||
@@ -1,4 +0,0 @@
|
||||
-----BEGIN PUBLIC KEY-----
|
||||
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEIWzT07fvTpQxWjTdewMipYH6f42+
|
||||
mM8niHm+T8y+Mvjanb3H8hpYXg3VjuJGFtcHw/hFX0Q2f2AiSHMF0DhMbQ==
|
||||
-----END PUBLIC KEY-----
|
||||
@@ -1,151 +0,0 @@
|
||||
#include "settings_menu.h"
|
||||
|
||||
#include "choices.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
|
||||
using Row = SettingsMenu::Row;
|
||||
using Kind = SettingsMenu::Kind;
|
||||
|
||||
struct RowDef {
|
||||
Row row;
|
||||
Kind kind;
|
||||
const char* label;
|
||||
};
|
||||
|
||||
const RowDef kRows[] = {
|
||||
{Row::LongName, Kind::Text, "Long name"}, {Row::ShortName, Kind::Text, "Short name"},
|
||||
{Row::Region, Kind::Choice, "Region"}, {Row::Timezone, Kind::Choice, "Timezone"},
|
||||
{Row::Brightness, Kind::Slider, "Brightness"}, {Row::DimTimeout, Kind::Choice, "Dim after"},
|
||||
{Row::OffTimeout, Kind::Choice, "Screen off after"}, {Row::Sound, Kind::Toggle, "Sound & LED"},
|
||||
{Row::Gnss, Kind::Toggle, "GNSS"}, {Row::Coordinates, Kind::Toggle, "Coordinates"},
|
||||
{Row::ProbeMacs, Kind::Toggle, "Probe MACs"}, {Row::Wifi, Kind::Page, "Wi-Fi"},
|
||||
{Row::Storage, Kind::Page, "Storage"},
|
||||
{Row::Firmware, Kind::Page, "Firmware"},
|
||||
{Row::About, Kind::Page, "About"},
|
||||
};
|
||||
|
||||
const int kDimSeconds[] = {10, 15, 30, 60, 120, 300};
|
||||
const int kOffSeconds[] = {30, 60, 120, 300, 600, 1800};
|
||||
|
||||
std::string formatSeconds(int s) { return s < 60 ? std::to_string(s) + " s" : std::to_string(s / 60) + " min"; }
|
||||
|
||||
template <size_t N>
|
||||
std::vector<std::string> labels(const Choice (&table)[N]) {
|
||||
std::vector<std::string> out;
|
||||
for (auto& c : table) out.push_back(c.label);
|
||||
return out;
|
||||
}
|
||||
|
||||
template <size_t N>
|
||||
std::vector<std::string> durations(const int (&seconds)[N]) {
|
||||
std::vector<std::string> out;
|
||||
for (int s : seconds) out.push_back(formatSeconds(s));
|
||||
return out;
|
||||
}
|
||||
|
||||
template <size_t N>
|
||||
int indexOf(const Choice (&table)[N], const std::string& value) {
|
||||
for (size_t i = 0; i < N; i++)
|
||||
if (value == table[i].value) return static_cast<int>(i);
|
||||
return -1;
|
||||
}
|
||||
|
||||
template <size_t N>
|
||||
int indexOf(const int (&table)[N], int value) {
|
||||
for (size_t i = 0; i < N; i++)
|
||||
if (table[i] == value) return static_cast<int>(i);
|
||||
return -1;
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
int SettingsMenu::count() const { return sizeof(kRows) / sizeof(kRows[0]); }
|
||||
SettingsMenu::Row SettingsMenu::row(int i) const { return kRows[i].row; }
|
||||
SettingsMenu::Kind SettingsMenu::kind(int i) const { return kRows[i].kind; }
|
||||
std::string SettingsMenu::label(int i) const { return kRows[i].label; }
|
||||
|
||||
std::string SettingsMenu::value(int i) const {
|
||||
switch (row(i)) {
|
||||
case Row::LongName: return settings_.getString(Setting::LongName);
|
||||
case Row::ShortName: return settings_.getString(Setting::ShortName);
|
||||
case Row::Region: return settings_.getString(Setting::Region);
|
||||
case Row::Timezone: {
|
||||
int c = currentChoice(i);
|
||||
return c >= 0 ? kTimezones[c].label : "Custom";
|
||||
}
|
||||
case Row::Brightness: return std::to_string(settings_.getInt(Setting::Brightness)) + "%";
|
||||
case Row::DimTimeout: return formatSeconds(settings_.getInt(Setting::DimTimeoutS));
|
||||
case Row::OffTimeout: return formatSeconds(settings_.getInt(Setting::OffTimeoutS));
|
||||
case Row::Sound: return settings_.getBool(Setting::Sound) ? "On" : "Off";
|
||||
case Row::Gnss: return settings_.getBool(Setting::GnssEnabled) ? "On" : "Off";
|
||||
case Row::Coordinates: return settings_.getBool(Setting::CoordinatesDms) ? "Deg min sec" : "Decimal";
|
||||
case Row::ProbeMacs: return settings_.getBool(Setting::ProbeMacRaw) ? "Raw" : "Pseudonymised";
|
||||
case Row::Wifi: return settings_.getBool(Setting::WifiEnabled) ? "On" : "Off";
|
||||
default: return "";
|
||||
}
|
||||
}
|
||||
|
||||
std::vector<std::string> SettingsMenu::choices(int i) const {
|
||||
switch (row(i)) {
|
||||
case Row::Region: return labels(kRegions);
|
||||
case Row::Timezone: return labels(kTimezones);
|
||||
case Row::DimTimeout: return durations(kDimSeconds);
|
||||
case Row::OffTimeout: return durations(kOffSeconds);
|
||||
default: return {};
|
||||
}
|
||||
}
|
||||
|
||||
int SettingsMenu::currentChoice(int i) const {
|
||||
switch (row(i)) {
|
||||
case Row::Region: return indexOf(kRegions, settings_.getString(Setting::Region));
|
||||
case Row::Timezone: return indexOf(kTimezones, settings_.getString(Setting::Timezone));
|
||||
case Row::DimTimeout: return indexOf(kDimSeconds, settings_.getInt(Setting::DimTimeoutS));
|
||||
case Row::OffTimeout: return indexOf(kOffSeconds, settings_.getInt(Setting::OffTimeoutS));
|
||||
default: return -1;
|
||||
}
|
||||
}
|
||||
|
||||
std::string SettingsMenu::choose(int i, int c) {
|
||||
switch (row(i)) {
|
||||
case Row::Region:
|
||||
settings_.setString(Setting::Region, kRegions[c].value);
|
||||
settings_.setBool(Setting::RegionConfirmed, true);
|
||||
return "";
|
||||
case Row::Timezone: settings_.setString(Setting::Timezone, kTimezones[c].value); return "";
|
||||
case Row::DimTimeout:
|
||||
return settings_.setInt(Setting::DimTimeoutS, kDimSeconds[c]) ? "" : "Dimming must happen before screen off";
|
||||
case Row::OffTimeout:
|
||||
return settings_.setInt(Setting::OffTimeoutS, kOffSeconds[c]) ? "" : "Screen off must come after dimming";
|
||||
default: return "Not a choice";
|
||||
}
|
||||
}
|
||||
|
||||
void SettingsMenu::toggle(int i) {
|
||||
if (row(i) == Row::Sound) settings_.setBool(Setting::Sound, !settings_.getBool(Setting::Sound));
|
||||
if (row(i) == Row::Gnss) settings_.setBool(Setting::GnssEnabled, !settings_.getBool(Setting::GnssEnabled));
|
||||
if (row(i) == Row::Coordinates) settings_.setBool(Setting::CoordinatesDms, !settings_.getBool(Setting::CoordinatesDms));
|
||||
if (row(i) == Row::ProbeMacs) settings_.setBool(Setting::ProbeMacRaw, !settings_.getBool(Setting::ProbeMacRaw));
|
||||
}
|
||||
|
||||
void SettingsMenu::adjust(int i, int direction) {
|
||||
if (row(i) != Row::Brightness) return;
|
||||
int next = settings_.getInt(Setting::Brightness) + (direction > 0 ? 10 : -10);
|
||||
if (next < 10) next = 10;
|
||||
if (next > 100) next = 100;
|
||||
settings_.setInt(Setting::Brightness, next);
|
||||
}
|
||||
|
||||
int SettingsMenu::maxBytes(int i) const {
|
||||
return row(i) == Row::ShortName ? 4 : row(i) == Row::LongName ? 39 : 0;
|
||||
}
|
||||
|
||||
std::string SettingsMenu::setText(int i, const std::string& text) {
|
||||
Setting s = row(i) == Row::ShortName ? Setting::ShortName : Setting::LongName;
|
||||
if (settings_.setString(s, text)) return "";
|
||||
return "Must be 1 to " + std::to_string(maxBytes(i)) + " bytes";
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,42 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "settings.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// What the Settings App lists: one row per user-facing setting (plus sub-pages), with readable
|
||||
// values, choice lists and validation messages. Rendering and navigation live in the App.
|
||||
class SettingsMenu {
|
||||
public:
|
||||
enum class Row { LongName, ShortName, Region, Timezone, Brightness, DimTimeout, OffTimeout, Sound, Gnss, Coordinates, ProbeMacs, Wifi, Storage, Firmware, About };
|
||||
enum class Kind { Text, Choice, Toggle, Slider, Page };
|
||||
|
||||
explicit SettingsMenu(Settings& settings) : settings_(settings) {}
|
||||
|
||||
int count() const;
|
||||
Row row(int i) const;
|
||||
Kind kind(int i) const;
|
||||
std::string label(int i) const;
|
||||
std::string value(int i) const;
|
||||
|
||||
// Choice rows
|
||||
std::vector<std::string> choices(int i) const;
|
||||
int currentChoice(int i) const; // -1 if the current value isn't one of the choices
|
||||
std::string choose(int i, int choice); // empty on success, otherwise why it was refused
|
||||
|
||||
// Toggle and Slider rows
|
||||
void toggle(int i);
|
||||
void adjust(int i, int direction);
|
||||
|
||||
// Text rows
|
||||
int maxBytes(int i) const;
|
||||
std::string setText(int i, const std::string& text); // empty on success, otherwise why
|
||||
|
||||
private:
|
||||
Settings& settings_;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,88 +0,0 @@
|
||||
#include "setup_wizard.h"
|
||||
|
||||
#include "choices.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
SetupWizard::SetupWizard(Settings& settings, std::string defaultLongName, std::string defaultShortName)
|
||||
: settings_(settings), longName_(std::move(defaultLongName)), shortName_(std::move(defaultShortName)) {}
|
||||
|
||||
int SetupWizard::choiceCount() const {
|
||||
if (step_ == Step::Region) return sizeof(kRegions) / sizeof(kRegions[0]);
|
||||
if (step_ == Step::Timezone) return sizeof(kTimezones) / sizeof(kTimezones[0]);
|
||||
return 0;
|
||||
}
|
||||
|
||||
std::string SetupWizard::choiceLabel(int i) const {
|
||||
return step_ == Step::Region ? kRegions[i].label : kTimezones[i].label;
|
||||
}
|
||||
|
||||
int SetupWizard::selectedChoice() const { return step_ == Step::Region ? region_ : timezone_; }
|
||||
|
||||
void SetupWizard::selectChoice(int i) {
|
||||
if (i < 0 || i >= choiceCount()) return;
|
||||
(step_ == Step::Region ? region_ : timezone_) = i;
|
||||
}
|
||||
|
||||
void SetupWizard::enter(Step step) {
|
||||
step_ = step;
|
||||
error_.clear();
|
||||
if (step == Step::LongName) {
|
||||
editor_ = LineEditor(39);
|
||||
editor_.setText(longName_);
|
||||
} else if (step == Step::ShortName) {
|
||||
editor_ = LineEditor(4);
|
||||
editor_.setText(shortName_);
|
||||
}
|
||||
}
|
||||
|
||||
bool SetupWizard::next() {
|
||||
switch (step_) {
|
||||
case Step::Welcome: enter(Step::LongName); return true;
|
||||
case Step::LongName:
|
||||
if (editor_.text().empty()) {
|
||||
error_ = "Please enter a name";
|
||||
return false;
|
||||
}
|
||||
longName_ = editor_.text();
|
||||
enter(Step::ShortName);
|
||||
return true;
|
||||
case Step::ShortName:
|
||||
if (editor_.text().empty()) {
|
||||
error_ = "Please enter 1 to 4 characters";
|
||||
return false;
|
||||
}
|
||||
shortName_ = editor_.text();
|
||||
enter(Step::Region);
|
||||
return true;
|
||||
case Step::Region: enter(Step::Timezone); return true;
|
||||
case Step::Timezone: enter(Step::Done); return true;
|
||||
case Step::Done:
|
||||
save();
|
||||
finished_ = true;
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
void SetupWizard::back() {
|
||||
switch (step_) {
|
||||
case Step::LongName: longName_ = editor_.text(); enter(Step::Welcome); break;
|
||||
case Step::ShortName: shortName_ = editor_.text(); enter(Step::LongName); break;
|
||||
case Step::Region: enter(Step::ShortName); break;
|
||||
case Step::Timezone: enter(Step::Region); break;
|
||||
case Step::Done: enter(Step::Timezone); break;
|
||||
case Step::Welcome: break;
|
||||
}
|
||||
}
|
||||
|
||||
void SetupWizard::save() {
|
||||
settings_.setString(Setting::LongName, longName_);
|
||||
settings_.setString(Setting::ShortName, shortName_);
|
||||
settings_.setString(Setting::Region, kRegions[region_].value);
|
||||
settings_.setString(Setting::Timezone, kTimezones[timezone_].value);
|
||||
settings_.setBool(Setting::RegionConfirmed, true);
|
||||
settings_.setBool(Setting::SetupDone, true);
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,46 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
|
||||
#include "line_editor.h"
|
||||
#include "settings.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// The first-boot setup flow: names, Region confirmation, timezone. Nothing is saved until the
|
||||
// last step, so an interrupted setup simply starts again at the next boot.
|
||||
class SetupWizard {
|
||||
public:
|
||||
enum class Step { Welcome, LongName, ShortName, Region, Timezone, Done };
|
||||
|
||||
SetupWizard(Settings& settings, std::string defaultLongName, std::string defaultShortName);
|
||||
|
||||
Step step() const { return step_; }
|
||||
bool finished() const { return finished_; }
|
||||
|
||||
// Name steps edit text; Region and Timezone steps pick a choice.
|
||||
LineEditor& editor() { return editor_; }
|
||||
int choiceCount() const;
|
||||
std::string choiceLabel(int i) const;
|
||||
int selectedChoice() const;
|
||||
void selectChoice(int i);
|
||||
|
||||
bool next(); // validates the step; false (with error()) if it can't advance
|
||||
void back();
|
||||
const std::string& error() const { return error_; }
|
||||
|
||||
private:
|
||||
void enter(Step step);
|
||||
void save();
|
||||
|
||||
Settings& settings_;
|
||||
Step step_ = Step::Welcome;
|
||||
bool finished_ = false;
|
||||
std::string error_;
|
||||
LineEditor editor_{39};
|
||||
std::string longName_, shortName_;
|
||||
int region_ = 0;
|
||||
int timezone_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,45 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
|
||||
#include "key_event.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
class Canvas; // provided by the widget kit
|
||||
|
||||
// A foreground, user-facing program (see CONTEXT.md). Exactly one App is on screen at a time.
|
||||
class App {
|
||||
public:
|
||||
virtual ~App() = default;
|
||||
|
||||
virtual void onEnter() {}
|
||||
virtual void onExit() {}
|
||||
|
||||
// Return true if the key was consumed. An unconsumed Back leaves the App.
|
||||
virtual bool onKey(const KeyEvent& event) {
|
||||
(void)event;
|
||||
return false;
|
||||
}
|
||||
|
||||
// True while the App is editing text: the arrow keys then type ; . , / and need Fn to move.
|
||||
virtual bool textEntryActive() const { return false; }
|
||||
|
||||
// Called every main-loop pass while in the foreground (e.g. to refresh live values).
|
||||
virtual void update(uint32_t nowMs) { (void)nowMs; }
|
||||
|
||||
virtual void draw(Canvas& canvas) = 0;
|
||||
|
||||
void requestRedraw() { redraw_ = true; }
|
||||
|
||||
bool consumeRedraw() {
|
||||
bool r = redraw_;
|
||||
redraw_ = false;
|
||||
return r;
|
||||
}
|
||||
|
||||
private:
|
||||
bool redraw_ = false;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,87 +0,0 @@
|
||||
#include "app_manager.h"
|
||||
|
||||
#include <cstring>
|
||||
|
||||
namespace roro {
|
||||
|
||||
AppManager::AppManager(App& launcher) : launcher_(launcher), foreground_(&launcher) {}
|
||||
|
||||
void AppManager::registerApp(const AppInfo& info) { apps_.push_back(info); }
|
||||
|
||||
std::vector<const AppInfo*> AppManager::visibleApps() const {
|
||||
std::vector<const AppInfo*> visible;
|
||||
for (auto& info : apps_)
|
||||
if (!info.hidden) visible.push_back(&info);
|
||||
return visible;
|
||||
}
|
||||
|
||||
void AppManager::begin() {
|
||||
foreground_ = &launcher_;
|
||||
launcher_.onEnter();
|
||||
redraw_ = true;
|
||||
}
|
||||
|
||||
App* AppManager::find(const char* id) const {
|
||||
for (auto& info : apps_)
|
||||
if (std::strcmp(info.id, id) == 0) return info.app;
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
bool AppManager::open(const char* id) {
|
||||
App* app = find(id);
|
||||
if (!app || modal_) return false;
|
||||
switchTo(*app);
|
||||
return true;
|
||||
}
|
||||
|
||||
void AppManager::home() {
|
||||
if (!modal_) switchTo(launcher_);
|
||||
}
|
||||
|
||||
bool AppManager::openModal(const char* id) {
|
||||
App* app = find(id);
|
||||
if (!app) return false;
|
||||
switchTo(*app);
|
||||
modal_ = true;
|
||||
return true;
|
||||
}
|
||||
|
||||
void AppManager::endModal() {
|
||||
modal_ = false;
|
||||
switchTo(launcher_);
|
||||
}
|
||||
|
||||
void AppManager::handleKey(const KeyEvent& event) {
|
||||
if (modal_) {
|
||||
foreground_->onKey(event);
|
||||
return;
|
||||
}
|
||||
if (event.key == Key::Home) {
|
||||
home();
|
||||
return;
|
||||
}
|
||||
bool consumed = foreground_->onKey(event);
|
||||
if (!consumed && event.key == Key::Back) home();
|
||||
}
|
||||
|
||||
const char* AppManager::foregroundTitle() const {
|
||||
for (auto& info : apps_)
|
||||
if (info.app == foreground_) return info.title;
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
bool AppManager::takeRedraw() {
|
||||
bool r = redraw_ | foreground_->consumeRedraw();
|
||||
redraw_ = false;
|
||||
return r;
|
||||
}
|
||||
|
||||
void AppManager::switchTo(App& app) {
|
||||
if (&app == foreground_) return;
|
||||
foreground_->onExit();
|
||||
foreground_ = &app;
|
||||
foreground_->onEnter();
|
||||
redraw_ = true;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,54 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <vector>
|
||||
|
||||
#include "app.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
struct AppInfo {
|
||||
const char* id;
|
||||
const char* title;
|
||||
bool hidden; // not listed in the Launcher, but can still be opened
|
||||
App* app;
|
||||
};
|
||||
|
||||
// Owns which App is in the foreground and routes keys. Home always returns to the Launcher;
|
||||
// Back is offered to the App first and returns to the Launcher if the App doesn't consume it.
|
||||
class AppManager {
|
||||
public:
|
||||
explicit AppManager(App& launcher);
|
||||
|
||||
void registerApp(const AppInfo& info);
|
||||
std::vector<const AppInfo*> visibleApps() const;
|
||||
|
||||
void begin();
|
||||
bool open(const char* id); // refused while a modal App runs
|
||||
void home();
|
||||
|
||||
// A modal App (e.g. the first-boot wizard) can't be left with Home or Back: those keys go to it,
|
||||
// and it ends itself with endModal(), which returns to the Launcher.
|
||||
bool openModal(const char* id);
|
||||
void endModal();
|
||||
|
||||
void handleKey(const KeyEvent& event);
|
||||
void update(uint32_t nowMs) { foreground_->update(nowMs); }
|
||||
|
||||
App& foreground() const { return *foreground_; }
|
||||
const char* foregroundTitle() const; // nullptr for the Launcher
|
||||
|
||||
// True once after the screen needs redrawing (App switch, or the App asked for it).
|
||||
bool takeRedraw();
|
||||
|
||||
private:
|
||||
void switchTo(App& app);
|
||||
App* find(const char* id) const;
|
||||
|
||||
App& launcher_;
|
||||
App* foreground_;
|
||||
std::vector<AppInfo> apps_;
|
||||
bool redraw_ = true;
|
||||
bool modal_ = false;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,43 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <cstring>
|
||||
|
||||
namespace roro {
|
||||
|
||||
enum class NotificationLevel : int32_t { Info, Warning, Message };
|
||||
|
||||
// Everything Services announce to the UI. Add new kinds before Count.
|
||||
enum class EventType : uint8_t {
|
||||
BatteryChanged, // a = percent, b = millivolts
|
||||
Notification, // text = message, a = NotificationLevel
|
||||
StorageThreshold, // a = usage percent, b = level now in effect (0 / 80 / 90 / 100)
|
||||
SettingChanged, // a = Setting, text = storage key
|
||||
Count
|
||||
};
|
||||
|
||||
// Small, fixed-size and copyable so it can cross tasks through a queue without allocating.
|
||||
struct Event {
|
||||
static constexpr size_t kTextCapacity = 48;
|
||||
|
||||
EventType type;
|
||||
int32_t a = 0;
|
||||
int32_t b = 0;
|
||||
char text[kTextCapacity] = {};
|
||||
|
||||
static Event withValues(EventType type, int32_t a, int32_t b = 0) {
|
||||
Event e{type};
|
||||
e.a = a;
|
||||
e.b = b;
|
||||
return e;
|
||||
}
|
||||
|
||||
static Event withText(EventType type, const char* text, int32_t a = 0) {
|
||||
Event e{type};
|
||||
e.a = a;
|
||||
std::strncpy(e.text, text, kTextCapacity - 1);
|
||||
return e;
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,46 +0,0 @@
|
||||
#include "event_bus.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
EventBus::EventBus(size_t capacity) : queue_(capacity) {}
|
||||
|
||||
bool EventBus::publish(const Event& event) {
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
if (count_ == queue_.size()) {
|
||||
dropped_++;
|
||||
return false;
|
||||
}
|
||||
queue_[(head_ + count_) % queue_.size()] = event;
|
||||
count_++;
|
||||
return true;
|
||||
}
|
||||
|
||||
void EventBus::subscribe(EventType type, Handler handler) {
|
||||
handlers_[static_cast<size_t>(type)].push_back(std::move(handler));
|
||||
}
|
||||
|
||||
size_t EventBus::dispatch() {
|
||||
size_t pending;
|
||||
{
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
pending = count_;
|
||||
}
|
||||
for (size_t i = 0; i < pending; i++) {
|
||||
Event event;
|
||||
{
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
event = queue_[head_];
|
||||
head_ = (head_ + 1) % queue_.size();
|
||||
count_--;
|
||||
}
|
||||
for (auto& handler : handlers_[static_cast<size_t>(event.type)]) handler(event);
|
||||
}
|
||||
return pending;
|
||||
}
|
||||
|
||||
uint32_t EventBus::dropped() const {
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
return dropped_;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,40 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <array>
|
||||
#include <functional>
|
||||
#include <mutex>
|
||||
#include <vector>
|
||||
|
||||
#include "event.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Services publish from any task; the UI task calls dispatch() to deliver events to subscribers.
|
||||
// Subscribe only during setup, from the UI task.
|
||||
class EventBus {
|
||||
public:
|
||||
using Handler = std::function<void(const Event&)>;
|
||||
|
||||
explicit EventBus(size_t capacity = 32);
|
||||
|
||||
// Thread-safe. Returns false (and counts a drop) if the queue is full.
|
||||
bool publish(const Event& event);
|
||||
|
||||
void subscribe(EventType type, Handler handler);
|
||||
|
||||
// Delivers the events queued before this call; events published meanwhile wait for the next one.
|
||||
// Returns how many events were delivered.
|
||||
size_t dispatch();
|
||||
|
||||
uint32_t dropped() const;
|
||||
|
||||
private:
|
||||
std::vector<Event> queue_;
|
||||
size_t head_ = 0;
|
||||
size_t count_ = 0;
|
||||
uint32_t dropped_ = 0;
|
||||
mutable std::mutex mutex_;
|
||||
std::array<std::vector<Handler>, static_cast<size_t>(EventType::Count)> handlers_;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,41 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Logical keys, already translated from the physical keyboard (Fn combos, Esc position, etc.).
|
||||
enum class Key : uint8_t {
|
||||
Char, // a printable character in `ch` (Unicode code point, accents already composed)
|
||||
Up,
|
||||
Down,
|
||||
Left,
|
||||
Right,
|
||||
Select,
|
||||
Back,
|
||||
Home,
|
||||
Tab,
|
||||
Delete,
|
||||
};
|
||||
|
||||
struct KeyEvent {
|
||||
Key key = Key::Char;
|
||||
uint32_t ch = 0;
|
||||
bool shift = false;
|
||||
bool ctrl = false;
|
||||
bool alt = false;
|
||||
|
||||
static KeyEvent of(Key key) {
|
||||
KeyEvent e;
|
||||
e.key = key;
|
||||
return e;
|
||||
}
|
||||
|
||||
static KeyEvent character(uint32_t codePoint) {
|
||||
KeyEvent e;
|
||||
e.ch = codePoint;
|
||||
return e;
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,20 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// A long-lived background capability (see CONTEXT.md). Services are ticked cooperatively from the
|
||||
// main loop; one that needs real concurrency (e.g. the radio) may run its own task internally and
|
||||
// report through the EventBus.
|
||||
class Service {
|
||||
public:
|
||||
virtual ~Service() = default;
|
||||
virtual const char* name() const = 0;
|
||||
virtual void start() {}
|
||||
virtual void stop() {}
|
||||
virtual void tick(uint32_t nowMs) { (void)nowMs; }
|
||||
virtual uint32_t tickIntervalMs() const { return 1000; }
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,33 +0,0 @@
|
||||
#include "service_manager.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
void ServiceManager::add(Service& service) { entries_.push_back({&service, 0, true}); }
|
||||
|
||||
void ServiceManager::startAll(uint32_t nowMs) {
|
||||
for (auto& e : entries_) {
|
||||
e.service->start();
|
||||
e.lastTickMs = nowMs;
|
||||
e.due = true;
|
||||
}
|
||||
running_ = true;
|
||||
}
|
||||
|
||||
void ServiceManager::stopAll() {
|
||||
for (auto it = entries_.rbegin(); it != entries_.rend(); ++it) it->service->stop();
|
||||
running_ = false;
|
||||
}
|
||||
|
||||
void ServiceManager::tick(uint32_t nowMs) {
|
||||
if (!running_) return;
|
||||
for (auto& e : entries_) {
|
||||
// Unsigned subtraction keeps working across the 49-day millis() wraparound.
|
||||
if (e.due || nowMs - e.lastTickMs >= e.service->tickIntervalMs()) {
|
||||
e.due = false;
|
||||
e.lastTickMs = nowMs;
|
||||
e.service->tick(nowMs);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,31 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <vector>
|
||||
|
||||
#include "service.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
class ServiceManager {
|
||||
public:
|
||||
void add(Service& service);
|
||||
|
||||
// Starts services in the order added; each gets its first tick on the next tick() call.
|
||||
void startAll(uint32_t nowMs);
|
||||
// Stops services in reverse order.
|
||||
void stopAll();
|
||||
|
||||
// Ticks every service whose interval has elapsed. Missed intervals are not replayed.
|
||||
void tick(uint32_t nowMs);
|
||||
|
||||
private:
|
||||
struct Entry {
|
||||
Service* service;
|
||||
uint32_t lastTickMs;
|
||||
bool due;
|
||||
};
|
||||
std::vector<Entry> entries_;
|
||||
bool running_ = false;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,50 +0,0 @@
|
||||
#include "geo_format.h"
|
||||
|
||||
#include <cmath>
|
||||
#include <cstdio>
|
||||
|
||||
namespace roro::gnss {
|
||||
|
||||
namespace {
|
||||
const char* hemisphere(double degrees, bool latitude) {
|
||||
return latitude ? (degrees < 0 ? "S" : "N") : (degrees < 0 ? "W" : "E");
|
||||
}
|
||||
} // namespace
|
||||
|
||||
std::string formatDecimal(double degrees, bool latitude) {
|
||||
char buf[32];
|
||||
std::snprintf(buf, sizeof buf, "%.5f\xC2\xB0 %s", std::fabs(degrees), hemisphere(degrees, latitude));
|
||||
return buf;
|
||||
}
|
||||
|
||||
std::string formatDms(double degrees, bool latitude) {
|
||||
// Work in tenths of a second, so rounding carries into minutes and degrees.
|
||||
long tenths = std::lround(std::fabs(degrees) * 36000.0);
|
||||
long d = tenths / 36000, m = tenths / 600 % 60, s10 = tenths % 600;
|
||||
char buf[40];
|
||||
std::snprintf(buf, sizeof buf, "%ld\xC2\xB0 %02ld' %02ld.%ld\" %s", d, m, s10 / 10, s10 % 10,
|
||||
hemisphere(degrees, latitude));
|
||||
return buf;
|
||||
}
|
||||
|
||||
std::string maidenhead(double latitude, double longitude) {
|
||||
double lon = std::fmin(std::fmax(longitude + 180.0, 0.0), 359.999999);
|
||||
double lat = std::fmin(std::fmax(latitude + 90.0, 0.0), 179.999999);
|
||||
std::string out;
|
||||
out += static_cast<char>('A' + static_cast<int>(lon / 20));
|
||||
out += static_cast<char>('A' + static_cast<int>(lat / 10));
|
||||
out += static_cast<char>('0' + static_cast<int>(std::fmod(lon, 20) / 2));
|
||||
out += static_cast<char>('0' + static_cast<int>(std::fmod(lat, 10)));
|
||||
out += static_cast<char>('a' + static_cast<int>(std::fmod(lon, 2) * 12));
|
||||
out += static_cast<char>('a' + static_cast<int>(std::fmod(lat, 1) * 24));
|
||||
return out;
|
||||
}
|
||||
|
||||
SkyPoint skyPosition(int azimuthDeg, int elevationDeg, int cx, int cy, int radius) {
|
||||
int elevation = elevationDeg < 0 ? 0 : elevationDeg > 90 ? 90 : elevationDeg;
|
||||
double r = radius * (90 - elevation) / 90.0;
|
||||
double az = azimuthDeg * M_PI / 180.0;
|
||||
return {cx + static_cast<int>(std::lround(r * std::sin(az))), cy - static_cast<int>(std::lround(r * std::cos(az)))};
|
||||
}
|
||||
|
||||
} // namespace roro::gnss
|
||||
@@ -1,21 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
|
||||
namespace roro::gnss {
|
||||
|
||||
// "50.86920° N": five decimals, about a metre.
|
||||
std::string formatDecimal(double degrees, bool latitude);
|
||||
// "50° 52' 09.1\" N" (Settings → Coordinates, Q64).
|
||||
std::string formatDms(double degrees, bool latitude);
|
||||
// The 6-character Maidenhead locator ("JO20ef"), as radio amateurs give their square.
|
||||
std::string maidenhead(double latitude, double longitude);
|
||||
|
||||
// Where a satellite goes on the Sky view: the zenith in the centre, the horizon on the circle,
|
||||
// north up and east right (as seen looking at the sky from above, like a map).
|
||||
struct SkyPoint {
|
||||
int x, y;
|
||||
};
|
||||
SkyPoint skyPosition(int azimuthDeg, int elevationDeg, int cx, int cy, int radius);
|
||||
|
||||
} // namespace roro::gnss
|
||||
@@ -1,234 +0,0 @@
|
||||
#include "nmea_parser.h"
|
||||
|
||||
#include <cstdlib>
|
||||
|
||||
namespace roro::gnss {
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr double kKmhPerKnot = 1.852;
|
||||
|
||||
int hexValue(char c) {
|
||||
if (c >= '0' && c <= '9') return c - '0';
|
||||
if (c >= 'A' && c <= 'F') return c - 'A' + 10;
|
||||
if (c >= 'a' && c <= 'f') return c - 'a' + 10;
|
||||
return -1;
|
||||
}
|
||||
|
||||
Constellation fromTalker(const std::string& t) {
|
||||
if (t == "GP") return Constellation::Gps;
|
||||
if (t == "GL") return Constellation::Glonass;
|
||||
if (t == "GA") return Constellation::Galileo;
|
||||
if (t == "GB" || t == "BD") return Constellation::BeiDou;
|
||||
if (t == "GQ" || t == "QZ") return Constellation::Qzss;
|
||||
if (t == "GI") return Constellation::Navic;
|
||||
return Constellation::Unknown; // GN: combined
|
||||
}
|
||||
|
||||
// GSA's system ID field (NMEA 4.10).
|
||||
Constellation fromSystemId(int id) {
|
||||
switch (id) {
|
||||
case 1: return Constellation::Gps;
|
||||
case 2: return Constellation::Glonass;
|
||||
case 3: return Constellation::Galileo;
|
||||
case 4: return Constellation::BeiDou;
|
||||
case 5: return Constellation::Qzss;
|
||||
case 6: return Constellation::Navic;
|
||||
default: return Constellation::Unknown;
|
||||
}
|
||||
}
|
||||
|
||||
bool number(const std::string& s, double& out) {
|
||||
if (s.empty()) return false;
|
||||
char* end;
|
||||
out = std::strtod(s.c_str(), &end);
|
||||
return *end == '\0';
|
||||
}
|
||||
|
||||
int integer(const std::string& s, int fallback = 0) {
|
||||
double v;
|
||||
return number(s, v) ? static_cast<int>(v) : fallback;
|
||||
}
|
||||
|
||||
// "ddmm.mmmm" / "dddmm.mmmm" with its hemisphere letter.
|
||||
bool coordinate(const std::string& value, const std::string& hemisphere, double& out) {
|
||||
double raw;
|
||||
if (!number(value, raw) || hemisphere.empty()) return false;
|
||||
int degrees = static_cast<int>(raw / 100);
|
||||
out = degrees + (raw - degrees * 100) / 60.0;
|
||||
if (hemisphere == "S" || hemisphere == "W") out = -out;
|
||||
return true;
|
||||
}
|
||||
|
||||
// Days since 1970-01-01 for a civil date (Howard Hinnant's algorithm).
|
||||
int64_t daysFromCivil(int y, int m, int d) {
|
||||
y -= m <= 2;
|
||||
const int64_t era = (y >= 0 ? y : y - 399) / 400;
|
||||
const unsigned yoe = static_cast<unsigned>(y - era * 400);
|
||||
const unsigned doy = (153 * (m + (m > 2 ? -3 : 9)) + 2) / 5 + d - 1;
|
||||
const unsigned doe = yoe * 365 + yoe / 4 - yoe / 100 + doy;
|
||||
return era * 146097 + static_cast<int64_t>(doe) - 719468;
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
const char* constellationName(Constellation c) {
|
||||
switch (c) {
|
||||
case Constellation::Gps: return "GPS";
|
||||
case Constellation::Glonass: return "GLONASS";
|
||||
case Constellation::Galileo: return "Galileo";
|
||||
case Constellation::BeiDou: return "BeiDou";
|
||||
case Constellation::Qzss: return "QZSS";
|
||||
case Constellation::Navic: return "NavIC";
|
||||
default: return "?";
|
||||
}
|
||||
}
|
||||
|
||||
int64_t GnssState::utcSeconds() const {
|
||||
return daysFromCivil(year, month, day) * 86400 + hour * 3600 + minute * 60 + second;
|
||||
}
|
||||
|
||||
void NmeaParser::feed(const char* data, size_t len) {
|
||||
for (size_t i = 0; i < len; i++) {
|
||||
char c = data[i];
|
||||
if (c == '\n') {
|
||||
if (!overflow_ && !line_.empty()) {
|
||||
if (onLine) onLine(line_);
|
||||
sentence(line_);
|
||||
}
|
||||
line_.clear();
|
||||
overflow_ = false;
|
||||
} else if (c != '\r') {
|
||||
if (line_.size() >= kMaxLine) overflow_ = true;
|
||||
else line_ += c;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
bool NmeaParser::sentence(const std::string& line) {
|
||||
size_t star = line.rfind('*');
|
||||
if (line.size() < 7 || line[0] != '$' || star == std::string::npos || star + 3 != line.size()) {
|
||||
bad_++;
|
||||
return false;
|
||||
}
|
||||
uint8_t sum = 0;
|
||||
for (size_t i = 1; i < star; i++) sum ^= static_cast<uint8_t>(line[i]);
|
||||
int hi = hexValue(line[star + 1]), lo = hexValue(line[star + 2]);
|
||||
if (hi < 0 || lo < 0 || sum != (hi << 4 | lo)) {
|
||||
bad_++;
|
||||
return false;
|
||||
}
|
||||
good_++;
|
||||
|
||||
Fields f;
|
||||
size_t start = 1;
|
||||
for (size_t i = 1; i <= star; i++)
|
||||
if (i == star || line[i] == ',') {
|
||||
f.push_back(line.substr(start, i - start));
|
||||
start = i + 1;
|
||||
}
|
||||
if (f[0].size() < 5) return true;
|
||||
std::string talker = f[0].substr(0, 2), type = f[0].substr(f[0].size() - 3);
|
||||
if (type == "RMC") rmc(f);
|
||||
else if (type == "GGA") gga(f);
|
||||
else if (type == "GSA") gsa(f, fromTalker(talker));
|
||||
else if (type == "GSV") gsv(f, fromTalker(talker));
|
||||
return true;
|
||||
}
|
||||
|
||||
void NmeaParser::rmc(const Fields& f) {
|
||||
if (f.size() < 10) return;
|
||||
bool active = f[2] == "A";
|
||||
double lat, lon;
|
||||
state_.positionValid = active && coordinate(f[3], f[4], lat) && coordinate(f[5], f[6], lon);
|
||||
if (state_.positionValid) {
|
||||
state_.latitude = lat;
|
||||
state_.longitude = lon;
|
||||
}
|
||||
double knots, course;
|
||||
state_.speedKmh = active && number(f[7], knots) ? static_cast<float>(knots * kKmhPerKnot) : 0;
|
||||
state_.courseValid = active && number(f[8], course);
|
||||
if (state_.courseValid) state_.courseDeg = static_cast<float>(course);
|
||||
|
||||
const std::string &t = f[1], &d = f[9];
|
||||
state_.timeValid = active && t.size() >= 6 && d.size() == 6;
|
||||
if (state_.timeValid) {
|
||||
state_.hour = integer(t.substr(0, 2));
|
||||
state_.minute = integer(t.substr(2, 2));
|
||||
state_.second = integer(t.substr(4, 2));
|
||||
state_.day = integer(d.substr(0, 2));
|
||||
state_.month = integer(d.substr(2, 2));
|
||||
state_.year = 2000 + integer(d.substr(4, 2));
|
||||
}
|
||||
}
|
||||
|
||||
void NmeaParser::gga(const Fields& f) {
|
||||
if (f.size() < 10) return;
|
||||
int quality = integer(f[6]);
|
||||
double lat, lon, hdop, alt;
|
||||
state_.positionValid = quality > 0 && coordinate(f[2], f[3], lat) && coordinate(f[4], f[5], lon);
|
||||
if (state_.positionValid) {
|
||||
state_.latitude = lat;
|
||||
state_.longitude = lon;
|
||||
}
|
||||
state_.satellitesUsed = integer(f[7]);
|
||||
if (number(f[8], hdop)) state_.hdop = static_cast<float>(hdop);
|
||||
state_.altitudeValid = quality > 0 && number(f[9], alt);
|
||||
if (state_.altitudeValid) state_.altitudeM = static_cast<float>(alt);
|
||||
}
|
||||
|
||||
void NmeaParser::gsa(const Fields& f, Constellation talker) {
|
||||
if (f.size() < 18) return;
|
||||
int mode = integer(f[2], 1);
|
||||
state_.fix = mode == 3 ? FixType::ThreeD : mode == 2 ? FixType::TwoD : FixType::None;
|
||||
Constellation system = f.size() > 18 ? fromSystemId(integer(f[18])) : talker;
|
||||
if (system == Constellation::Unknown) return; // can't tell whose satellites these are
|
||||
std::set<int>& used = used_[static_cast<int>(system)];
|
||||
used.clear();
|
||||
for (size_t i = 3; i <= 14; i++)
|
||||
if (!f[i].empty()) used.insert(integer(f[i]));
|
||||
rebuildSatellites();
|
||||
}
|
||||
|
||||
void NmeaParser::gsv(const Fields& f, Constellation talker) {
|
||||
if (f.size() < 4 || talker == Constellation::Unknown) return;
|
||||
int total = integer(f[1]), number = integer(f[2]);
|
||||
size_t extra = f.size() - 4;
|
||||
int signal = extra % 4 == 1 ? integer(f.back()) : 0; // NMEA 4.10 signal ID, last
|
||||
auto key = std::make_pair(static_cast<int>(talker), signal);
|
||||
std::vector<Satellite>& pending = pending_[key];
|
||||
if (number == 1) pending.clear();
|
||||
for (size_t i = 4; i + 3 < f.size(); i += 4) {
|
||||
Satellite s;
|
||||
s.system = talker;
|
||||
s.prn = integer(f[i]);
|
||||
s.elevation = integer(f[i + 1]);
|
||||
s.azimuth = integer(f[i + 2]);
|
||||
s.snr = integer(f[i + 3], -1);
|
||||
if (s.prn > 0) pending.push_back(s);
|
||||
}
|
||||
if (number == total) {
|
||||
inView_[key] = pending;
|
||||
pending.clear();
|
||||
rebuildSatellites();
|
||||
}
|
||||
}
|
||||
|
||||
void NmeaParser::rebuildSatellites() {
|
||||
std::vector<Satellite> merged;
|
||||
for (auto& [key, list] : inView_)
|
||||
for (const Satellite& s : list) {
|
||||
Satellite* same = nullptr;
|
||||
for (auto& m : merged)
|
||||
if (m.system == s.system && m.prn == s.prn) same = &m;
|
||||
if (!same) merged.push_back(s);
|
||||
else if (s.snr > same->snr) same->snr = s.snr;
|
||||
}
|
||||
for (auto& s : merged) {
|
||||
auto it = used_.find(static_cast<int>(s.system));
|
||||
s.used = it != used_.end() && it->second.count(s.prn) > 0;
|
||||
}
|
||||
state_.satellites = std::move(merged);
|
||||
}
|
||||
|
||||
} // namespace roro::gnss
|
||||
@@ -1,82 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
#include <functional>
|
||||
#include <map>
|
||||
#include <set>
|
||||
#include <string>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
|
||||
namespace roro::gnss {
|
||||
|
||||
enum class Constellation : uint8_t { Unknown, Gps, Glonass, Galileo, BeiDou, Qzss, Navic };
|
||||
const char* constellationName(Constellation c);
|
||||
|
||||
enum class FixType : uint8_t { None, TwoD, ThreeD };
|
||||
|
||||
struct Satellite {
|
||||
Constellation system = Constellation::Unknown;
|
||||
int prn = 0;
|
||||
int elevation = 0; // degrees above the horizon
|
||||
int azimuth = 0; // degrees from north, clockwise
|
||||
int snr = -1; // dB-Hz; -1 when not tracked
|
||||
bool used = false; // part of the current Fix
|
||||
};
|
||||
|
||||
// Everything the receiver has said, as of the last sentence (see CONTEXT.md: Fix).
|
||||
struct GnssState {
|
||||
FixType fix = FixType::None;
|
||||
bool positionValid = false;
|
||||
double latitude = 0, longitude = 0; // degrees, south and west negative
|
||||
bool altitudeValid = false;
|
||||
float altitudeM = 0; // above mean sea level
|
||||
float speedKmh = 0;
|
||||
bool courseValid = false;
|
||||
float courseDeg = 0;
|
||||
int satellitesUsed = 0;
|
||||
float hdop = 99.9f;
|
||||
// UTC, trusted only with a Fix: the receiver reports a time without one, from its own clock.
|
||||
bool timeValid = false;
|
||||
int year = 0, month = 0, day = 0, hour = 0, minute = 0, second = 0;
|
||||
std::vector<Satellite> satellites; // in view, all constellations, one entry per satellite
|
||||
|
||||
int64_t utcSeconds() const; // seconds since 1970-01-01 UTC; meaningful when timeValid
|
||||
};
|
||||
|
||||
// NMEA 0183 (4.10 style, as the Cap's AT6668 sends it): RMC, GGA, GSA and GSV, with the
|
||||
// constellation taken from the talker ID or GSA's system ID field. Host-tested; no hardware here.
|
||||
class NmeaParser {
|
||||
public:
|
||||
// Raw bytes from the UART, in any chunks.
|
||||
void feed(const char* data, size_t len);
|
||||
// One sentence without its line end. False if malformed or its checksum is wrong.
|
||||
bool sentence(const std::string& line);
|
||||
|
||||
// Called with every complete line fed in, valid or not (`gnss nmea on` echoes them).
|
||||
std::function<void(const std::string&)> onLine;
|
||||
|
||||
const GnssState& state() const { return state_; }
|
||||
uint32_t goodSentences() const { return good_; }
|
||||
uint32_t badSentences() const { return bad_; }
|
||||
|
||||
private:
|
||||
using Fields = std::vector<std::string>;
|
||||
void rmc(const Fields& f);
|
||||
void gga(const Fields& f);
|
||||
void gsa(const Fields& f, Constellation talker);
|
||||
void gsv(const Fields& f, Constellation talker);
|
||||
void rebuildSatellites();
|
||||
|
||||
static constexpr size_t kMaxLine = 120;
|
||||
std::string line_;
|
||||
bool overflow_ = false;
|
||||
uint32_t good_ = 0, bad_ = 0;
|
||||
GnssState state_;
|
||||
// GSV sequences per (constellation, signal): pending until their last message.
|
||||
std::map<std::pair<int, int>, std::vector<Satellite>> pending_, inView_;
|
||||
std::map<int, std::set<int>> used_; // per constellation, from GSA
|
||||
};
|
||||
|
||||
} // namespace roro::gnss
|
||||
@@ -1,76 +0,0 @@
|
||||
#include "track.h"
|
||||
|
||||
#include <cmath>
|
||||
#include <cstdio>
|
||||
#include <ctime>
|
||||
|
||||
namespace roro::gnss {
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr double kEarthRadiusM = 6371000.0;
|
||||
|
||||
double radians(double degrees) { return degrees * M_PI / 180.0; }
|
||||
|
||||
// UTC fields from seconds since 1970 (gmtime_r works on the device and the PC alike).
|
||||
struct tm utc(int64_t seconds) {
|
||||
time_t t = static_cast<time_t>(seconds);
|
||||
struct tm out;
|
||||
gmtime_r(&t, &out);
|
||||
return out;
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
double distanceMeters(double lat1, double lon1, double lat2, double lon2) {
|
||||
double dLat = radians(lat2 - lat1), dLon = radians(lon2 - lon1);
|
||||
double h = std::sin(dLat / 2) * std::sin(dLat / 2) +
|
||||
std::cos(radians(lat1)) * std::cos(radians(lat2)) * std::sin(dLon / 2) * std::sin(dLon / 2);
|
||||
return 2 * kEarthRadiusM * std::asin(std::sqrt(h));
|
||||
}
|
||||
|
||||
bool TrackRule::due(uint32_t nowMs, double lat, double lon) {
|
||||
if (any_ && (nowMs - lastMs_ < kEveryMs || distanceMeters(lat_, lon_, lat, lon) < kMinMeters)) return false;
|
||||
any_ = true;
|
||||
lastMs_ = nowMs;
|
||||
lat_ = lat;
|
||||
lon_ = lon;
|
||||
return true;
|
||||
}
|
||||
|
||||
std::string trackPath(int64_t utcSeconds) {
|
||||
struct tm t = utc(utcSeconds);
|
||||
char buf[48];
|
||||
std::snprintf(buf, sizeof buf, "/gnss/tracks/%04d%02d%02d-%02d%02d%02d.gpx", t.tm_year + 1900, t.tm_mon + 1,
|
||||
t.tm_mday, t.tm_hour, t.tm_min, t.tm_sec);
|
||||
return buf;
|
||||
}
|
||||
|
||||
namespace gpx {
|
||||
|
||||
std::string header(const std::string& name) {
|
||||
return "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
|
||||
"<gpx version=\"1.1\" creator=\"roro9stack\" xmlns=\"http://www.topografix.com/GPX/1/1\">\n"
|
||||
"<trk><name>" + name + "</name><trkseg>";
|
||||
}
|
||||
|
||||
std::string point(double lat, double lon, bool hasElevation, float elevationM, int64_t utcSeconds) {
|
||||
struct tm t = utc(utcSeconds);
|
||||
char buf[160], ele[32] = "";
|
||||
if (hasElevation) std::snprintf(ele, sizeof ele, "<ele>%.1f</ele>", elevationM);
|
||||
std::snprintf(buf, sizeof buf,
|
||||
"<trkpt lat=\"%.7f\" lon=\"%.7f\">%s<time>%04d-%02d-%02dT%02d:%02d:%02dZ</time></trkpt>", lat, lon,
|
||||
ele, t.tm_year + 1900, t.tm_mon + 1, t.tm_mday, t.tm_hour, t.tm_min, t.tm_sec);
|
||||
return buf;
|
||||
}
|
||||
|
||||
std::string footer() { return "</trkseg></trk></gpx>"; }
|
||||
|
||||
bool finished(const std::string& tail) {
|
||||
size_t end = tail.find_last_not_of(" \r\n\t");
|
||||
return end != std::string::npos && end + 1 >= 6 && tail.compare(end + 1 - 6, 6, "</gpx>") == 0;
|
||||
}
|
||||
|
||||
} // namespace gpx
|
||||
|
||||
} // namespace roro::gnss
|
||||
@@ -1,40 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
|
||||
namespace roro::gnss {
|
||||
|
||||
// Great-circle distance in metres (haversine, mean Earth radius).
|
||||
double distanceMeters(double lat1, double lon1, double lat2, double lon2);
|
||||
|
||||
// When a Track takes its next point (Q63): the first one always, then at least every 5 s and only
|
||||
// after moving at least 5 m, so standing still doesn't fill the card.
|
||||
class TrackRule {
|
||||
public:
|
||||
static constexpr uint32_t kEveryMs = 5000;
|
||||
static constexpr double kMinMeters = 5.0;
|
||||
|
||||
// True if this position should be recorded (and is then remembered as the last point).
|
||||
bool due(uint32_t nowMs, double lat, double lon);
|
||||
void reset() { any_ = false; }
|
||||
|
||||
private:
|
||||
bool any_ = false;
|
||||
uint32_t lastMs_ = 0;
|
||||
double lat_ = 0, lon_ = 0;
|
||||
};
|
||||
|
||||
// "/gnss/tracks/YYYYMMDD-HHMMSS.gpx", from the UTC start time (Storage Clean-up reads its date).
|
||||
std::string trackPath(int64_t utcSeconds);
|
||||
|
||||
// GPX 1.1, written a line at a time: the header when a Track starts, a point per line, the footer
|
||||
// when it stops. A file whose footer never came (power lost) is closed at the next boot.
|
||||
namespace gpx {
|
||||
std::string header(const std::string& name);
|
||||
std::string point(double lat, double lon, bool hasElevation, float elevationM, int64_t utcSeconds);
|
||||
std::string footer();
|
||||
bool finished(const std::string& tail); // the end of a file: does it close the GPX?
|
||||
} // namespace gpx
|
||||
|
||||
} // namespace roro::gnss
|
||||
@@ -1,114 +0,0 @@
|
||||
#include "key_mapper.h"
|
||||
|
||||
#include <algorithm>
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr char kArmed = '*';
|
||||
|
||||
bool isAccent(char c) { return c == '\'' || c == '`' || c == '^' || c == '"' || c == ',' || c == '~'; }
|
||||
|
||||
// Latin-1 code point for accent + base letter, or 0.
|
||||
uint32_t composeLatin1(char accent, char base) {
|
||||
struct Entry {
|
||||
char accent;
|
||||
const char* bases;
|
||||
const uint32_t* codes;
|
||||
};
|
||||
static const uint32_t acute[] = {0xE1, 0xE9, 0xED, 0xF3, 0xFA, 0xFD, 0xC1, 0xC9, 0xCD, 0xD3, 0xDA, 0xDD};
|
||||
static const uint32_t grave[] = {0xE0, 0xE8, 0xEC, 0xF2, 0xF9, 0xC0, 0xC8, 0xCC, 0xD2, 0xD9};
|
||||
static const uint32_t circ[] = {0xE2, 0xEA, 0xEE, 0xF4, 0xFB, 0xC2, 0xCA, 0xCE, 0xD4, 0xDB};
|
||||
static const uint32_t diaer[] = {0xE4, 0xEB, 0xEF, 0xF6, 0xFC, 0xFF, 0xC4, 0xCB, 0xCF, 0xD6, 0xDC};
|
||||
static const uint32_t cedil[] = {0xE7, 0xC7};
|
||||
static const uint32_t tilde[] = {0xE3, 0xF1, 0xF5, 0xC3, 0xD1, 0xD5};
|
||||
static const Entry table[] = {
|
||||
{'\'', "aeiouyAEIOUY", acute}, {'`', "aeiouAEIOU", grave}, {'^', "aeiouAEIOU", circ},
|
||||
{'"', "aeiouyAEIOU", diaer}, {',', "cC", cedil}, {'~', "anoANO", tilde},
|
||||
};
|
||||
for (auto& e : table) {
|
||||
if (e.accent != accent) continue;
|
||||
for (int i = 0; e.bases[i]; i++)
|
||||
if (e.bases[i] == base) return e.codes[i];
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
KeyEvent charEvent(uint32_t cp, const RawKeys& keys) {
|
||||
KeyEvent e = KeyEvent::character(cp);
|
||||
e.shift = keys.shift;
|
||||
e.ctrl = keys.ctrl;
|
||||
e.alt = keys.alt;
|
||||
return e;
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
std::vector<KeyEvent> KeyMapper::update(const RawKeys& keys) {
|
||||
std::vector<KeyEvent> out;
|
||||
|
||||
if (keys.opt && !previous_.opt && keys.chars.empty()) {
|
||||
compose_ = compose_ ? 0 : kArmed; // a second opt cancels
|
||||
}
|
||||
if (keys.enter && !previous_.enter) out.push_back(KeyEvent::of(Key::Select));
|
||||
if (keys.del && !previous_.del) out.push_back(KeyEvent::of(Key::Delete));
|
||||
if (keys.tab && !previous_.tab) out.push_back(KeyEvent::of(Key::Tab));
|
||||
|
||||
for (char c : keys.chars) {
|
||||
bool wasHeld = std::find(previous_.chars.begin(), previous_.chars.end(), c) != previous_.chars.end();
|
||||
if (!wasHeld) onChar(c, keys, out);
|
||||
}
|
||||
|
||||
previous_ = keys;
|
||||
return out;
|
||||
}
|
||||
|
||||
void KeyMapper::onChar(char c, const RawKeys& keys, std::vector<KeyEvent>& out) {
|
||||
// Holding opt while typing the accent is the same as pressing opt first.
|
||||
if (keys.opt && !compose_) compose_ = kArmed;
|
||||
|
||||
if (compose_ == kArmed) {
|
||||
if (isAccent(c)) {
|
||||
compose_ = c;
|
||||
return;
|
||||
}
|
||||
compose_ = 0; // not an accent: type it normally below
|
||||
} else if (compose_) {
|
||||
char accent = compose_;
|
||||
compose_ = 0;
|
||||
uint32_t composed = composeLatin1(accent, c);
|
||||
if (composed) {
|
||||
out.push_back(charEvent(composed, keys));
|
||||
} else {
|
||||
out.push_back(charEvent(static_cast<unsigned char>(accent), keys));
|
||||
out.push_back(charEvent(static_cast<unsigned char>(c), keys));
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
if (keys.fn || !textEntry_) {
|
||||
switch (c) {
|
||||
case ';': out.push_back(KeyEvent::of(Key::Up)); return;
|
||||
case '.': out.push_back(KeyEvent::of(Key::Down)); return;
|
||||
case ',': out.push_back(KeyEvent::of(Key::Left)); return;
|
||||
case '/': out.push_back(KeyEvent::of(Key::Right)); return;
|
||||
case '`':
|
||||
if (keys.fn) {
|
||||
out.push_back(KeyEvent::of(Key::Home));
|
||||
return;
|
||||
}
|
||||
break;
|
||||
default:
|
||||
if (keys.fn) return; // other Fn combos are unassigned
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (c == '`') {
|
||||
out.push_back(KeyEvent::of(Key::Back));
|
||||
return;
|
||||
}
|
||||
out.push_back(charEvent(static_cast<unsigned char>(c), keys));
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,47 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <vector>
|
||||
|
||||
#include "key_event.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// The physical keyboard state as reported by the keyboard driver: every character key currently
|
||||
// held (already shifted) plus the modifier and special keys.
|
||||
struct RawKeys {
|
||||
std::vector<char> chars;
|
||||
bool fn = false;
|
||||
bool opt = false;
|
||||
bool ctrl = false;
|
||||
bool alt = false;
|
||||
bool shift = false;
|
||||
bool enter = false;
|
||||
bool del = false;
|
||||
bool tab = false;
|
||||
};
|
||||
|
||||
// Turns keyboard state changes into logical KeyEvents: only newly pressed keys produce events;
|
||||
// Fn + ; . , / are arrows, and so are ; . , / alone when no text is being entered; ` is Back and
|
||||
// Fn + ` is Home; the Compose Key (opt) followed by an accent and a letter types the accented
|
||||
// letter (opt ' e -> é).
|
||||
class KeyMapper {
|
||||
public:
|
||||
std::vector<KeyEvent> update(const RawKeys& keys);
|
||||
|
||||
// Whether the foreground App is editing text (default). Outside text entry, the arrow keys
|
||||
// don't need Fn.
|
||||
void setTextEntry(bool active) { textEntry_ = active; }
|
||||
|
||||
// 0 when idle, '*' when opt was pressed, or the accent character waiting for its letter.
|
||||
char pendingCompose() const { return compose_; }
|
||||
|
||||
private:
|
||||
void onChar(char c, const RawKeys& keys, std::vector<KeyEvent>& out);
|
||||
|
||||
RawKeys previous_;
|
||||
char compose_ = 0;
|
||||
bool textEntry_ = true;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,31 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
|
||||
namespace roro {
|
||||
|
||||
inline std::string base64Encode(const std::string& in) {
|
||||
static const char* kAlphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
|
||||
std::string out;
|
||||
size_t i = 0;
|
||||
while (i + 2 < in.size()) {
|
||||
uint32_t n = (static_cast<uint8_t>(in[i]) << 16) | (static_cast<uint8_t>(in[i + 1]) << 8) | static_cast<uint8_t>(in[i + 2]);
|
||||
out += kAlphabet[n >> 18];
|
||||
out += kAlphabet[(n >> 12) & 63];
|
||||
out += kAlphabet[(n >> 6) & 63];
|
||||
out += kAlphabet[n & 63];
|
||||
i += 3;
|
||||
}
|
||||
size_t rest = in.size() - i;
|
||||
if (rest) {
|
||||
uint32_t n = static_cast<uint8_t>(in[i]) << 16;
|
||||
if (rest == 2) n |= static_cast<uint8_t>(in[i + 1]) << 8;
|
||||
out += kAlphabet[n >> 18];
|
||||
out += kAlphabet[(n >> 12) & 63];
|
||||
out += rest == 2 ? kAlphabet[(n >> 6) & 63] : '=';
|
||||
out += '=';
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,84 +0,0 @@
|
||||
#include "irc_config.h"
|
||||
|
||||
#include <cctype>
|
||||
#include <cstring>
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
bool validNick(const std::string& n) {
|
||||
if (n.empty() || n.size() > 30) return false;
|
||||
if (std::isdigit(static_cast<unsigned char>(n[0])) || n[0] == '-') return false;
|
||||
for (char c : n)
|
||||
if (!std::isalnum(static_cast<unsigned char>(c)) && !std::strchr("[]\\`_^{|}-", c)) return false;
|
||||
return true;
|
||||
}
|
||||
} // namespace
|
||||
|
||||
void IrcConfig::load(const std::string& defaultNick) {
|
||||
nick = defaultNick;
|
||||
std::string s;
|
||||
int32_t i;
|
||||
if (store_.getString("irc_host", s)) host = s;
|
||||
if (store_.getInt("irc_port", i)) port = i;
|
||||
if (store_.getInt("irc_tls", i)) tls = i != 0;
|
||||
if (store_.getInt("irc_selfsign", i)) allowSelfSigned = i != 0;
|
||||
store_.getString("irc_pin", pinnedSha256);
|
||||
if (store_.getString("irc_nick", s)) nick = s;
|
||||
store_.getString("irc_sasl_user", saslUser);
|
||||
store_.getString("irc_sasl_pass", saslPassword);
|
||||
store_.getString("irc_ns_pass", nickservPassword);
|
||||
if (store_.getString("irc_join", s)) autojoin = parseChannels(s);
|
||||
}
|
||||
|
||||
std::string IrcConfig::validate() const {
|
||||
if (host.empty() || host.size() > 63) return "Server must be 1 to 63 characters";
|
||||
if (port < 1 || port > 65535) return "Port must be 1 to 65535";
|
||||
if (!validNick(nick)) return "Nick: letters, digits and []\\`_^{|}- only, not starting with a digit";
|
||||
for (auto& c : autojoin)
|
||||
if (c.channel.size() < 2 || (c.channel[0] != '#' && c.channel[0] != '&'))
|
||||
return "Auto-join: IRC channels start with # or &, each followed by its key if it has one";
|
||||
return "";
|
||||
}
|
||||
|
||||
std::string IrcConfig::save() {
|
||||
std::string error = validate();
|
||||
if (!error.empty()) return error;
|
||||
store_.putString("irc_host", host);
|
||||
store_.putInt("irc_port", port);
|
||||
store_.putInt("irc_tls", tls ? 1 : 0);
|
||||
store_.putInt("irc_selfsign", allowSelfSigned ? 1 : 0);
|
||||
store_.putString("irc_pin", pinnedSha256);
|
||||
store_.putString("irc_nick", nick);
|
||||
store_.putString("irc_sasl_user", saslUser);
|
||||
store_.putString("irc_sasl_pass", saslPassword);
|
||||
store_.putString("irc_ns_pass", nickservPassword);
|
||||
store_.putString("irc_join", formatChannels(autojoin));
|
||||
return "";
|
||||
}
|
||||
|
||||
std::vector<IrcChannel> IrcConfig::parseChannels(const std::string& text) {
|
||||
std::vector<IrcChannel> out;
|
||||
std::string word;
|
||||
auto take = [&]() {
|
||||
if (word.empty()) return;
|
||||
bool channel = word[0] == '#' || word[0] == '&';
|
||||
if (!channel && !out.empty() && out.back().key.empty()) out.back().key = word;
|
||||
else out.push_back({word, ""}); // a stray word fails validation as a channel
|
||||
word.clear();
|
||||
};
|
||||
for (char c : text) {
|
||||
if (c == ' ' || c == ',') take();
|
||||
else word += c;
|
||||
}
|
||||
take();
|
||||
return out;
|
||||
}
|
||||
|
||||
std::string IrcConfig::formatChannels(const std::vector<IrcChannel>& channels) {
|
||||
std::string out;
|
||||
for (auto& c : channels) out += (out.empty() ? "" : ", ") + c.channel + (c.key.empty() ? "" : " " + c.key);
|
||||
return out;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,58 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "key_value_store.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
struct IrcChannel {
|
||||
std::string channel; // "#roro"
|
||||
std::string key; // empty when the IRC channel has none
|
||||
};
|
||||
|
||||
// The one IRC server the IRC Service connects to, persisted in internal flash.
|
||||
class IrcConfig {
|
||||
public:
|
||||
explicit IrcConfig(KeyValueStore& store) : store_(store) {}
|
||||
|
||||
std::string host = "irc.libera.chat";
|
||||
int port = 6697;
|
||||
bool tls = true;
|
||||
bool allowSelfSigned = false; // pin the certificate on first use instead of checking a CA
|
||||
std::string pinnedSha256; // hex fingerprint once pinned
|
||||
std::string nick;
|
||||
std::string saslUser, saslPassword; // SASL PLAIN when both are set
|
||||
std::string nickservPassword; // otherwise IDENTIFY with NickServ, if set
|
||||
std::vector<IrcChannel> autojoin;
|
||||
|
||||
// A copy is a draft the UI can edit freely; copySettingsFrom() applies one.
|
||||
IrcConfig(const IrcConfig&) = default;
|
||||
void copySettingsFrom(const IrcConfig& other) {
|
||||
host = other.host;
|
||||
port = other.port;
|
||||
tls = other.tls;
|
||||
allowSelfSigned = other.allowSelfSigned;
|
||||
pinnedSha256 = other.pinnedSha256;
|
||||
nick = other.nick;
|
||||
saslUser = other.saslUser;
|
||||
saslPassword = other.saslPassword;
|
||||
nickservPassword = other.nickservPassword;
|
||||
autojoin = other.autojoin;
|
||||
}
|
||||
|
||||
void load(const std::string& defaultNick);
|
||||
std::string save(); // empty on success, otherwise why it was refused
|
||||
std::string validate() const;
|
||||
|
||||
// "#private key, #public": a word starting with # or & is an IRC channel, the word after it
|
||||
// (if it doesn't) its key. Spaces or commas separate entries, so "#a #b" also reads.
|
||||
static std::vector<IrcChannel> parseChannels(const std::string& text);
|
||||
static std::string formatChannels(const std::vector<IrcChannel>& channels);
|
||||
|
||||
private:
|
||||
KeyValueStore& store_;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,43 +0,0 @@
|
||||
#include "irc_message.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
IrcMessage IrcMessage::parse(const std::string& raw) {
|
||||
IrcMessage m;
|
||||
std::string line = raw;
|
||||
while (!line.empty() && (line.back() == '\r' || line.back() == '\n')) line.pop_back();
|
||||
|
||||
size_t pos = 0;
|
||||
auto word = [&]() {
|
||||
size_t end = line.find(' ', pos);
|
||||
std::string w = line.substr(pos, end == std::string::npos ? std::string::npos : end - pos);
|
||||
pos = end == std::string::npos ? line.size() : end + 1;
|
||||
while (pos < line.size() && line[pos] == ' ') pos++;
|
||||
return w;
|
||||
};
|
||||
if (pos < line.size() && line[pos] == '@') word();
|
||||
if (pos < line.size() && line[pos] == ':') m.prefix = word().substr(1);
|
||||
m.command = word();
|
||||
while (pos < line.size()) {
|
||||
if (line[pos] == ':') {
|
||||
m.params.push_back(line.substr(pos + 1));
|
||||
break;
|
||||
}
|
||||
m.params.push_back(word());
|
||||
}
|
||||
return m;
|
||||
}
|
||||
|
||||
std::string IrcMessage::serialize(const std::string& command, std::initializer_list<std::string> params) {
|
||||
std::string out = command;
|
||||
size_t i = 0;
|
||||
for (auto& p : params) {
|
||||
bool last = ++i == params.size();
|
||||
out += ' ';
|
||||
if (last && (p.empty() || p[0] == ':' || p.find(' ') != std::string::npos)) out += ':';
|
||||
out += p;
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,23 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <initializer_list>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// One IRC protocol line: [@tags] [:prefix] COMMAND params... [:trailing] (tags are ignored).
|
||||
struct IrcMessage {
|
||||
std::string prefix;
|
||||
std::string command;
|
||||
std::vector<std::string> params;
|
||||
|
||||
std::string nick() const { return prefix.substr(0, prefix.find('!')); }
|
||||
std::string param(size_t i) const { return i < params.size() ? params[i] : ""; }
|
||||
|
||||
static IrcMessage parse(const std::string& line);
|
||||
// Builds a line; the last parameter gets a ':' when it needs one.
|
||||
static std::string serialize(const std::string& command, std::initializer_list<std::string> params);
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,369 +0,0 @@
|
||||
#include "irc_session.h"
|
||||
|
||||
#include <algorithm>
|
||||
#include <cctype>
|
||||
|
||||
#include "base64.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
|
||||
const char kCtcp = '\x01';
|
||||
|
||||
std::string lower(std::string s) {
|
||||
for (auto& c : s) c = static_cast<char>(std::tolower(static_cast<unsigned char>(c)));
|
||||
return s;
|
||||
}
|
||||
|
||||
bool isChannel(const std::string& name) { return !name.empty() && (name[0] == '#' || name[0] == '&'); }
|
||||
|
||||
bool nickChar(char c) { return std::isalnum(static_cast<unsigned char>(c)) || std::string("[]\\`_^{|}-").find(c) != std::string::npos; }
|
||||
|
||||
std::string join(const std::vector<std::string>& params, size_t from) {
|
||||
std::string out;
|
||||
for (size_t i = from; i < params.size(); i++) out += (out.empty() ? "" : " ") + params[i];
|
||||
return out;
|
||||
}
|
||||
|
||||
// Splits "word rest of text" into the first word and the rest.
|
||||
std::pair<std::string, std::string> firstWord(const std::string& text) {
|
||||
size_t space = text.find(' ');
|
||||
if (space == std::string::npos) return {text, ""};
|
||||
return {text.substr(0, space), text.substr(space + 1)};
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
IrcSession::IrcSession(const IrcConfig& config) : config_(config), nick_(config.nick) {
|
||||
buffers_.push_back({config.host, IrcBuffer::Type::Server, {}, 0, false, true, ""});
|
||||
for (auto& c : config.autojoin)
|
||||
if (!c.key.empty()) keys_[lower(c.channel)] = c.key;
|
||||
}
|
||||
|
||||
void IrcSession::tick(uint32_t nowMs) {
|
||||
nowMs_ = nowMs;
|
||||
if (joinsHeld_ && nowMs - heldSinceMs_ >= kNickservWaitMs) joinChannels();
|
||||
}
|
||||
|
||||
int IrcSession::totalUnread() const {
|
||||
int n = 0;
|
||||
for (auto& b : buffers_) n += b.unread;
|
||||
return n;
|
||||
}
|
||||
|
||||
IrcEffects IrcSession::takeEffects() {
|
||||
IrcEffects out;
|
||||
std::swap(out, effects_);
|
||||
return out;
|
||||
}
|
||||
|
||||
int IrcSession::findBuffer(const std::string& name) const {
|
||||
for (int i = 0; i < bufferCount(); i++)
|
||||
if (lower(buffers_[i].name) == lower(name)) return i;
|
||||
return -1;
|
||||
}
|
||||
|
||||
int IrcSession::bufferFor(const std::string& name, IrcBuffer::Type type) {
|
||||
int i = findBuffer(name);
|
||||
if (i >= 0) return i;
|
||||
if (bufferCount() >= kMaxBuffers) return 0; // full: fall back to the server Buffer
|
||||
buffers_.push_back({name, type, {}, 0, false, false, ""});
|
||||
revision_++;
|
||||
return bufferCount() - 1;
|
||||
}
|
||||
|
||||
void IrcSession::setViewing(int buffer) {
|
||||
viewing_ = buffer;
|
||||
revision_++;
|
||||
if (buffer >= 0 && buffer < bufferCount()) {
|
||||
buffers_[buffer].unread = 0;
|
||||
buffers_[buffer].mentioned = false;
|
||||
}
|
||||
}
|
||||
|
||||
bool IrcSession::mentionsMe(const std::string& text) const {
|
||||
std::string hay = lower(text), needle = lower(nick_);
|
||||
for (size_t pos = hay.find(needle); pos != std::string::npos; pos = hay.find(needle, pos + 1)) {
|
||||
bool startOk = pos == 0 || !nickChar(hay[pos - 1]);
|
||||
size_t end = pos + needle.size();
|
||||
bool endOk = end >= hay.size() || !nickChar(hay[end]);
|
||||
if (startOk && endOk) return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
void IrcSession::add(int b, IrcLine::Kind kind, const std::string& nick, const std::string& text, int64_t utc,
|
||||
bool mention) {
|
||||
IrcBuffer& buf = buffers_[b];
|
||||
revision_++;
|
||||
IrcLine line{utc, kind, nick, text};
|
||||
buf.lines.push_back(line);
|
||||
if (buf.lines.size() > kLinesPerBuffer) buf.lines.pop_front();
|
||||
effects_.logs.push_back({buf.name, line});
|
||||
|
||||
bool fromOthers = kind == IrcLine::Kind::Message || kind == IrcLine::Kind::Action || kind == IrcLine::Kind::Notice;
|
||||
if (b != viewing_ && fromOthers && buf.type != IrcBuffer::Type::Server) {
|
||||
buf.unread++;
|
||||
if (mention) {
|
||||
buf.mentioned = true;
|
||||
std::string where = buf.type == IrcBuffer::Type::Query ? nick : nick + " in " + buf.name;
|
||||
effects_.notifications.push_back(where + ": " + text);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void IrcSession::connected(int64_t) {
|
||||
registered_ = false;
|
||||
joinsHeld_ = false;
|
||||
saslFailed_ = false;
|
||||
quit_ = false;
|
||||
nick_ = config_.nick;
|
||||
if (!config_.saslUser.empty() && !config_.saslPassword.empty()) send("CAP REQ :sasl");
|
||||
send(IrcMessage::serialize("NICK", {nick_}));
|
||||
send(IrcMessage::serialize("USER", {nick_, "0", "*", "roro9stack"}));
|
||||
}
|
||||
|
||||
void IrcSession::disconnected(int64_t utc, const std::string& reason) {
|
||||
registered_ = false;
|
||||
quit_ = false;
|
||||
rejoin_.clear();
|
||||
for (int i = 0; i < bufferCount(); i++) {
|
||||
if (buffers_[i].type == IrcBuffer::Type::Channel && buffers_[i].joined) rejoin_.push_back(buffers_[i].name);
|
||||
if (buffers_[i].type == IrcBuffer::Type::Channel) buffers_[i].joined = false;
|
||||
info(i, "-- " + reason + " --", utc);
|
||||
}
|
||||
}
|
||||
|
||||
void IrcSession::onWelcome(const IrcMessage& m, int64_t utc) {
|
||||
registered_ = true;
|
||||
nick_ = m.param(0);
|
||||
info(0, "Connected to " + config_.host + " as " + nick_, utc);
|
||||
// NickServ when it's the configured login, or as the fallback when SASL failed.
|
||||
// The account is named explicitly: we may be on a fallback nick if a stale session holds ours.
|
||||
bool sasl = !config_.saslUser.empty() && !config_.saslPassword.empty();
|
||||
std::string account = sasl ? config_.saslUser : config_.nick;
|
||||
std::string identify;
|
||||
if (!config_.nickservPassword.empty() && (!sasl || saslFailed_)) identify = account + " " + config_.nickservPassword;
|
||||
else if (sasl && saslFailed_) identify = account + " " + config_.saslPassword;
|
||||
if (!identify.empty()) {
|
||||
// IRC channels for registered users only would refuse us until NickServ has logged us in.
|
||||
send(IrcMessage::serialize("PRIVMSG", {"NickServ", "IDENTIFY " + identify}));
|
||||
joinsHeld_ = true;
|
||||
heldSinceMs_ = nowMs_;
|
||||
return;
|
||||
}
|
||||
joinChannels();
|
||||
}
|
||||
|
||||
void IrcSession::joinChannels() {
|
||||
joinsHeld_ = false;
|
||||
std::vector<std::string> channels;
|
||||
auto addOnce = [&](const std::string& c) {
|
||||
for (auto& existing : channels)
|
||||
if (lower(existing) == lower(c)) return;
|
||||
channels.push_back(c);
|
||||
};
|
||||
for (auto& c : config_.autojoin) addOnce(c.channel);
|
||||
for (auto& c : rejoin_) addOnce(c);
|
||||
rejoin_.clear();
|
||||
if (channels.empty()) return;
|
||||
|
||||
// JOIN #keyed,#open key: IRC pairs keys with the first channels listed.
|
||||
std::string keyed, open, keys;
|
||||
for (auto& c : channels) {
|
||||
auto k = keys_.find(lower(c));
|
||||
if (k != keys_.end()) {
|
||||
keyed += (keyed.empty() ? "" : ",") + c;
|
||||
keys += (keys.empty() ? "" : ",") + k->second;
|
||||
} else {
|
||||
open += (open.empty() ? "" : ",") + c;
|
||||
}
|
||||
}
|
||||
std::string list = keyed + (!keyed.empty() && !open.empty() ? "," : "") + open;
|
||||
send(keys.empty() ? IrcMessage::serialize("JOIN", {list}) : IrcMessage::serialize("JOIN", {list, keys}));
|
||||
}
|
||||
|
||||
void IrcSession::receive(const std::string& raw, int64_t utc) {
|
||||
IrcMessage m = IrcMessage::parse(raw);
|
||||
const std::string& cmd = m.command;
|
||||
bool fromMe = lower(m.nick()) == lower(nick_);
|
||||
|
||||
if (cmd == "PING") {
|
||||
send(IrcMessage::serialize("PONG", {m.param(0)}));
|
||||
} else if (cmd == "001") {
|
||||
onWelcome(m, utc);
|
||||
} else if (cmd == "433" && !registered_) {
|
||||
nick_ += "_";
|
||||
send(IrcMessage::serialize("NICK", {nick_}));
|
||||
} else if (cmd == "CAP") {
|
||||
std::string sub = m.param(1);
|
||||
if (sub == "ACK" && m.param(2).find("sasl") != std::string::npos) send("AUTHENTICATE PLAIN");
|
||||
else if (sub == "NAK") send("CAP END");
|
||||
} else if (cmd == "AUTHENTICATE" && m.param(0) == "+") {
|
||||
std::string user = config_.saslUser;
|
||||
send("AUTHENTICATE " + base64Encode(user + '\0' + user + '\0' + config_.saslPassword));
|
||||
} else if (cmd == "900") {
|
||||
// Logged in. Take our nick back from a stale session, then join.
|
||||
if (lower(nick_) != lower(config_.nick))
|
||||
send(IrcMessage::serialize("PRIVMSG", {"NickServ", "REGAIN " + config_.nick}));
|
||||
if (joinsHeld_) joinChannels();
|
||||
} else if (cmd == "903") {
|
||||
info(0, "SASL login succeeded", utc);
|
||||
send("CAP END");
|
||||
} else if (cmd == "904" || cmd == "905" || cmd == "906" || cmd == "902") {
|
||||
info(0, "SASL login failed: " + m.param(m.params.size() - 1) + " (trying NickServ instead)", utc);
|
||||
saslFailed_ = true;
|
||||
send("CAP END");
|
||||
} else if (cmd == "PRIVMSG" || cmd == "NOTICE") {
|
||||
onPrivmsg(m, utc, cmd == "NOTICE");
|
||||
} else if (cmd == "JOIN") {
|
||||
if (fromMe) {
|
||||
int b = bufferFor(m.param(0), IrcBuffer::Type::Channel);
|
||||
buffers_[b].joined = true;
|
||||
info(b, "Joined " + m.param(0), utc);
|
||||
}
|
||||
} else if (cmd == "PART") {
|
||||
int b = findBuffer(m.param(0));
|
||||
if (fromMe && b > 0) {
|
||||
buffers_[b].joined = false;
|
||||
info(b, "Left " + m.param(0), utc);
|
||||
}
|
||||
} else if (cmd == "KICK") {
|
||||
int b = findBuffer(m.param(0));
|
||||
if (lower(m.param(1)) == lower(nick_) && b > 0) {
|
||||
buffers_[b].joined = false;
|
||||
add(b, IrcLine::Kind::Notice, m.nick(), "kicked you: " + m.param(2), utc, true);
|
||||
}
|
||||
} else if (cmd == "NICK") {
|
||||
if (fromMe) {
|
||||
nick_ = m.param(0);
|
||||
info(0, "You are now " + nick_, utc);
|
||||
} else {
|
||||
int b = findBuffer(m.nick());
|
||||
if (b > 0) {
|
||||
buffers_[b].name = m.param(0);
|
||||
info(b, m.nick() + " is now " + m.param(0), utc);
|
||||
}
|
||||
}
|
||||
} else if (cmd == "TOPIC") {
|
||||
int b = findBuffer(m.param(0));
|
||||
if (b > 0) {
|
||||
buffers_[b].topic = m.param(1);
|
||||
info(b, m.nick() + " set the topic: " + m.param(1), utc);
|
||||
}
|
||||
} else if (cmd == "332") {
|
||||
int b = findBuffer(m.param(1));
|
||||
if (b > 0) {
|
||||
buffers_[b].topic = m.param(2);
|
||||
info(b, "Topic: " + m.param(2), utc);
|
||||
}
|
||||
} else if (cmd == "353") {
|
||||
std::string channel = m.param(2);
|
||||
int b = findBuffer(channel);
|
||||
if (namesRequested_.count(lower(channel)) && b >= 0) info(b, "Names: " + m.param(3), utc);
|
||||
} else if (cmd == "366") {
|
||||
namesRequested_.erase(lower(m.param(1)));
|
||||
} else if (cmd == "ERROR") {
|
||||
info(0, "Server: " + m.param(0), utc);
|
||||
} else if (cmd.size() == 3 && std::isdigit(static_cast<unsigned char>(cmd[0])) && cmd != "333" && cmd != "353") {
|
||||
info(0, join(m.params, 1), utc); // other numerics, minus our own nick
|
||||
}
|
||||
}
|
||||
|
||||
void IrcSession::onPrivmsg(const IrcMessage& m, int64_t utc, bool notice) {
|
||||
std::string target = m.param(0), text = m.param(1), from = m.nick();
|
||||
bool toMe = lower(target) == lower(nick_);
|
||||
|
||||
// CTCP: ACTION is shown, VERSION answered, anything else ignored.
|
||||
bool action = false;
|
||||
if (!text.empty() && text[0] == kCtcp) {
|
||||
std::string body = text.substr(1, text.size() >= 2 && text.back() == kCtcp ? text.size() - 2 : std::string::npos);
|
||||
auto [verb, rest] = firstWord(body);
|
||||
if (verb == "ACTION") {
|
||||
action = true;
|
||||
text = rest;
|
||||
} else {
|
||||
if (verb == "VERSION" && !notice) send(std::string("NOTICE ") + from + " :" + kCtcp + "VERSION roro9stack" + kCtcp);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
int b;
|
||||
if (notice && (from.empty() || from.find('.') != std::string::npos || !registered_ || target == "*")) {
|
||||
b = 0; // server notices
|
||||
} else if (toMe) {
|
||||
b = notice ? (findBuffer(from) > 0 ? findBuffer(from) : 0) : bufferFor(from, IrcBuffer::Type::Query);
|
||||
} else {
|
||||
b = bufferFor(target, IrcBuffer::Type::Channel);
|
||||
}
|
||||
auto kind = notice ? IrcLine::Kind::Notice : action ? IrcLine::Kind::Action : IrcLine::Kind::Message;
|
||||
bool mention = !notice && (toMe || mentionsMe(text));
|
||||
add(b, kind, from, text, utc, mention);
|
||||
}
|
||||
|
||||
void IrcSession::say(int b, const std::string& text, int64_t utc, bool action) {
|
||||
const IrcBuffer& buf = buffers_[b];
|
||||
if (buf.type == IrcBuffer::Type::Server) {
|
||||
info(b, "This is the server Buffer: /join #name an IRC channel, or /msg nick text", utc);
|
||||
return;
|
||||
}
|
||||
std::string payload = action ? std::string(1, kCtcp) + "ACTION " + text + kCtcp : text;
|
||||
send(IrcMessage::serialize("PRIVMSG", {buf.name, payload}));
|
||||
add(b, action ? IrcLine::Kind::OwnAction : IrcLine::Kind::Own, nick_, text, utc);
|
||||
}
|
||||
|
||||
void IrcSession::input(int b, const std::string& text, int64_t utc) {
|
||||
if (b < 0 || b >= bufferCount() || text.empty()) return;
|
||||
if (text.size() >= 2 && text[0] == '/' && text[1] == '/') return say(b, text.substr(1), utc, false);
|
||||
if (text[0] == '/') return command(b, text.substr(1), utc);
|
||||
say(b, text, utc, false);
|
||||
}
|
||||
|
||||
void IrcSession::command(int b, const std::string& text, int64_t utc) {
|
||||
auto [verb, rest] = firstWord(text);
|
||||
verb = lower(verb);
|
||||
const IrcBuffer& buf = buffers_[b];
|
||||
bool inChannel = buf.type == IrcBuffer::Type::Channel;
|
||||
|
||||
if (verb == "join" || verb == "j") {
|
||||
auto [channel, key] = firstWord(rest);
|
||||
if (channel.empty()) return info(b, "Usage: /join #channel", utc);
|
||||
if (!isChannel(channel)) channel = "#" + channel;
|
||||
if (!key.empty()) keys_[lower(channel)] = key; // reused when rejoining
|
||||
send(key.empty() ? IrcMessage::serialize("JOIN", {channel}) : IrcMessage::serialize("JOIN", {channel, key}));
|
||||
} else if (verb == "part") {
|
||||
std::string channel = inChannel ? buf.name : "";
|
||||
std::string message = rest;
|
||||
if (isChannel(rest)) std::tie(channel, message) = firstWord(rest);
|
||||
if (channel.empty()) return info(b, "Usage: /part #channel", utc);
|
||||
send(message.empty() ? IrcMessage::serialize("PART", {channel}) : IrcMessage::serialize("PART", {channel, message}));
|
||||
} else if (verb == "msg" || verb == "query") {
|
||||
auto [who, message] = firstWord(rest);
|
||||
if (who.empty()) return info(b, "Usage: /msg nick text", utc);
|
||||
int target = bufferFor(who, isChannel(who) ? IrcBuffer::Type::Channel : IrcBuffer::Type::Query);
|
||||
if (!message.empty()) say(target, message, utc, false);
|
||||
} else if (verb == "me") {
|
||||
say(b, rest, utc, true);
|
||||
} else if (verb == "nick") {
|
||||
if (rest.empty()) return info(b, "Usage: /nick newnick", utc);
|
||||
send(IrcMessage::serialize("NICK", {rest}));
|
||||
} else if (verb == "topic") {
|
||||
if (!inChannel) return info(b, "Use /topic in an IRC channel", utc);
|
||||
send(rest.empty() ? IrcMessage::serialize("TOPIC", {buf.name}) : IrcMessage::serialize("TOPIC", {buf.name, rest}));
|
||||
} else if (verb == "names") {
|
||||
std::string channel = rest.empty() ? (inChannel ? buf.name : "") : rest;
|
||||
if (channel.empty()) return info(b, "Usage: /names #channel", utc);
|
||||
namesRequested_.insert(lower(channel));
|
||||
send(IrcMessage::serialize("NAMES", {channel}));
|
||||
} else if (verb == "quit") {
|
||||
quit_ = true;
|
||||
send(IrcMessage::serialize("QUIT", {rest.empty() ? "roro9stack" : rest}));
|
||||
} else if (verb == "raw" || verb == "quote") {
|
||||
if (!rest.empty()) send(rest);
|
||||
} else {
|
||||
info(b, "Unknown command /" + verb + " (try /join or /j, /part /msg /me /nick /topic /names /quit /raw)", utc);
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,114 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <deque>
|
||||
#include <map>
|
||||
#include <set>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "irc_config.h"
|
||||
#include "irc_message.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
struct IrcLine {
|
||||
enum class Kind { Message, Action, Notice, Info, Own, OwnAction };
|
||||
int64_t utc; // -1 if the clock wasn't set
|
||||
Kind kind;
|
||||
std::string nick;
|
||||
std::string text;
|
||||
};
|
||||
|
||||
// One IRC conversation (see Buffer in CONTEXT.md).
|
||||
struct IrcBuffer {
|
||||
enum class Type { Server, Channel, Query };
|
||||
std::string name;
|
||||
Type type;
|
||||
std::deque<IrcLine> lines; // the most recent kLinesPerBuffer; full history goes to Logs
|
||||
int unread = 0;
|
||||
bool mentioned = false;
|
||||
bool joined = false;
|
||||
std::string topic;
|
||||
};
|
||||
|
||||
struct IrcLogEntry {
|
||||
std::string buffer;
|
||||
IrcLine line;
|
||||
};
|
||||
|
||||
// What the session wants done: lines to send, Log entries, Notification texts.
|
||||
struct IrcEffects {
|
||||
std::vector<std::string> send;
|
||||
std::vector<IrcLogEntry> logs;
|
||||
std::vector<std::string> notifications;
|
||||
};
|
||||
|
||||
// The IRC protocol, without any networking: registration (SASL PLAIN or NickServ), Buffers,
|
||||
// unread counts, Mentions, the user's commands, and rejoining after a pause. The IRC Service
|
||||
// feeds it received lines and carries out the effects.
|
||||
class IrcSession {
|
||||
public:
|
||||
static constexpr size_t kLinesPerBuffer = 50;
|
||||
static constexpr int kMaxBuffers = 12;
|
||||
|
||||
explicit IrcSession(const IrcConfig& config);
|
||||
|
||||
// Joins wait this long for NickServ to confirm a login before going ahead anyway.
|
||||
static constexpr uint32_t kNickservWaitMs = 2000;
|
||||
|
||||
// Uptime in ms, called regularly: releases joins held back for NickServ.
|
||||
void tick(uint32_t nowMs);
|
||||
|
||||
void connected(int64_t utc);
|
||||
void disconnected(int64_t utc, const std::string& reason);
|
||||
void receive(const std::string& raw, int64_t utc);
|
||||
void input(int buffer, const std::string& text, int64_t utc);
|
||||
|
||||
// The Buffer the user is looking at (-1: none); it neither counts unread nor notifies.
|
||||
void setViewing(int buffer);
|
||||
|
||||
bool registered() const { return registered_; }
|
||||
bool quitRequested() const { return quit_; }
|
||||
const std::string& nick() const { return nick_; }
|
||||
|
||||
int bufferCount() const { return static_cast<int>(buffers_.size()); }
|
||||
const IrcBuffer& buffer(int i) const { return buffers_[i]; }
|
||||
int totalUnread() const;
|
||||
// Changes whenever a Buffer gains a line or changes, so a view knows when to redraw.
|
||||
uint32_t revision() const { return revision_; }
|
||||
|
||||
IrcEffects takeEffects();
|
||||
|
||||
private:
|
||||
void send(const std::string& line) { effects_.send.push_back(line); }
|
||||
int findBuffer(const std::string& name) const;
|
||||
int bufferFor(const std::string& name, IrcBuffer::Type type); // creates if needed and possible
|
||||
void add(int buffer, IrcLine::Kind kind, const std::string& nick, const std::string& text, int64_t utc,
|
||||
bool countsAsMention = false);
|
||||
void info(int buffer, const std::string& text, int64_t utc) { add(buffer, IrcLine::Kind::Info, "", text, utc); }
|
||||
bool mentionsMe(const std::string& text) const;
|
||||
void onPrivmsg(const IrcMessage& m, int64_t utc, bool notice);
|
||||
void onWelcome(const IrcMessage& m, int64_t utc);
|
||||
void joinChannels();
|
||||
void command(int buffer, const std::string& text, int64_t utc);
|
||||
void say(int buffer, const std::string& text, int64_t utc, bool action);
|
||||
|
||||
const IrcConfig& config_;
|
||||
std::vector<IrcBuffer> buffers_;
|
||||
std::string nick_;
|
||||
bool registered_ = false;
|
||||
bool quit_ = false;
|
||||
int viewing_ = -1;
|
||||
std::set<std::string> namesRequested_;
|
||||
std::vector<std::string> rejoin_; // IRC channels to join again after a reconnect
|
||||
std::map<std::string, std::string> keys_; // lower-case IRC channel -> key, from config and /join
|
||||
bool joinsHeld_ = false; // waiting for NickServ before joining
|
||||
bool saslFailed_ = false;
|
||||
uint32_t heldSinceMs_ = 0;
|
||||
uint32_t nowMs_ = 0;
|
||||
IrcEffects effects_;
|
||||
uint32_t revision_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,21 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Waits between IRC reconnection attempts: 5 s, 10 s, 30 s, 1 min, 2 min, then every 5 min.
|
||||
class ReconnectPolicy {
|
||||
public:
|
||||
uint32_t nextDelayMs() {
|
||||
static const uint32_t kDelays[] = {5000, 10000, 30000, 60000, 120000, 300000};
|
||||
const int n = sizeof(kDelays) / sizeof(kDelays[0]);
|
||||
return kDelays[attempt_ < n ? attempt_++ : n - 1];
|
||||
}
|
||||
void reset() { attempt_ = 0; }
|
||||
|
||||
private:
|
||||
int attempt_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,114 +0,0 @@
|
||||
#include "file_receiver.h"
|
||||
|
||||
#include <algorithm>
|
||||
#include <cstdlib>
|
||||
#include <cstring>
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
|
||||
int hexDigit(char c) {
|
||||
if (c >= '0' && c <= '9') return c - '0';
|
||||
if (c >= 'a' && c <= 'f') return c - 'a' + 10;
|
||||
if (c >= 'A' && c <= 'F') return c - 'A' + 10;
|
||||
return -1;
|
||||
}
|
||||
|
||||
// Splits on spaces (no iostreams: they cost about 200 KB of flash on the device).
|
||||
std::vector<std::string> words(const std::string& s) {
|
||||
std::vector<std::string> out;
|
||||
size_t i = 0;
|
||||
while (i < s.size()) {
|
||||
if (s[i] == ' ') {
|
||||
i++;
|
||||
continue;
|
||||
}
|
||||
size_t end = s.find(' ', i);
|
||||
if (end == std::string::npos) end = s.size();
|
||||
out.push_back(s.substr(i, end - i));
|
||||
i = end;
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
std::string FileReceiver::begin(const std::string& args, uint32_t nowMs) {
|
||||
reset();
|
||||
std::vector<std::string> w = words(args);
|
||||
if (w.size() != 3) return "usage: sd put <path> <size> <sha256>";
|
||||
const std::string &path = w[0], &size = w[1], &sha = w[2];
|
||||
if (path.empty() || path[0] != '/' || path.size() > 128 || path.find("..") != std::string::npos)
|
||||
return "the path must be absolute, without ..";
|
||||
if (size.empty() || size.size() > 9 || size.find_first_not_of("0123456789") != std::string::npos)
|
||||
return "bad size";
|
||||
uint32_t bytes = static_cast<uint32_t>(std::strtoul(size.c_str(), nullptr, 10));
|
||||
if (bytes == 0 || bytes > kMaxBytes) return "bad size";
|
||||
if (sha.size() != 64) return "bad sha256";
|
||||
for (size_t i = 0; i < 32; i++) {
|
||||
int hi = hexDigit(sha[2 * i]), lo = hexDigit(sha[2 * i + 1]);
|
||||
if (hi < 0 || lo < 0) return "bad sha256";
|
||||
expected_[i] = static_cast<uint8_t>(hi << 4 | lo);
|
||||
}
|
||||
path_ = path;
|
||||
size_ = bytes;
|
||||
lastActivityMs_ = nowMs;
|
||||
chunk_.reserve(kChunk);
|
||||
state_ = State::Receiving;
|
||||
return "";
|
||||
}
|
||||
|
||||
size_t FileReceiver::wanted() const {
|
||||
if (state_ != State::Receiving) return 0;
|
||||
return std::min<size_t>(kChunk, size_ - received_) - chunk_.size();
|
||||
}
|
||||
|
||||
size_t FileReceiver::feed(const uint8_t* data, size_t len, uint32_t nowMs) {
|
||||
if (state_ != State::Receiving || len == 0) return 0;
|
||||
size_t take = std::min(len, wanted());
|
||||
chunk_.insert(chunk_.end(), data, data + take);
|
||||
sha_.update(data, take);
|
||||
lastActivityMs_ = nowMs;
|
||||
if (wanted() > 0) return take;
|
||||
|
||||
if (received_ + chunk_.size() == size_) {
|
||||
// The last chunk: refuse it before writing if the file arrived damaged.
|
||||
uint8_t got[32];
|
||||
sha_.finish(got);
|
||||
if (std::memcmp(got, expected_, sizeof got) != 0) {
|
||||
fail("checksum mismatch");
|
||||
return take;
|
||||
}
|
||||
}
|
||||
state_ = State::Writing;
|
||||
return take;
|
||||
}
|
||||
|
||||
void FileReceiver::chunkWritten(bool ok, uint32_t nowMs) {
|
||||
if (state_ != State::Writing) return;
|
||||
if (!ok) return fail("write failed");
|
||||
received_ += static_cast<uint32_t>(chunk_.size());
|
||||
chunk_.clear();
|
||||
lastActivityMs_ = nowMs;
|
||||
state_ = received_ == size_ ? State::Finishing : State::Receiving;
|
||||
}
|
||||
|
||||
void FileReceiver::finished(bool ok) {
|
||||
if (state_ != State::Finishing) return;
|
||||
if (!ok) return fail("rename failed");
|
||||
state_ = State::Done;
|
||||
}
|
||||
|
||||
void FileReceiver::tick(uint32_t nowMs) {
|
||||
if (state_ != State::Receiving && state_ != State::Writing && state_ != State::Finishing) return;
|
||||
if (nowMs - lastActivityMs_ >= kTimeoutMs) fail(state_ == State::Receiving ? "timed out" : "card not writable");
|
||||
}
|
||||
|
||||
void FileReceiver::fail(const char* why) {
|
||||
error_ = why;
|
||||
chunk_.clear();
|
||||
state_ = State::Failed;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,66 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "sha256.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// One file sent over the USB serial console (scripts/sd_put.py), to put an Update File on the SD
|
||||
// card without taking the card out. The sender writes `sd put <path> <size> <sha256>`, then the raw
|
||||
// bytes, one chunk at a time, and waits for each chunk to be written before sending the next: the
|
||||
// serial driver drops bytes once its receive buffer is full. The file lands as `<path>.part` and is
|
||||
// renamed to `<path>` only once every byte has arrived and the checksum matches.
|
||||
class FileReceiver {
|
||||
public:
|
||||
static constexpr size_t kChunk = 1024; // must stay below the serial receive buffer
|
||||
static constexpr uint32_t kTimeoutMs = 5000; // silence, or a card job that never completes
|
||||
static constexpr uint32_t kMaxBytes = 8u << 20; // larger than any app partition
|
||||
|
||||
enum class State {
|
||||
Idle,
|
||||
Receiving, // waiting for bytes of the current chunk
|
||||
Writing, // chunk() is complete: write it to partPath(), then call chunkWritten()
|
||||
Finishing, // everything written and checked: rename partPath() to path(), then finished()
|
||||
Done,
|
||||
Failed, // error() says why; partPath() should be removed
|
||||
};
|
||||
|
||||
// Parses "<path> <size> <sha256 hex>". Returns "" when the transfer starts, or what's wrong.
|
||||
std::string begin(const std::string& args, uint32_t nowMs);
|
||||
// Takes bytes for the current chunk; returns how many were used (none while a chunk waits).
|
||||
size_t feed(const uint8_t* data, size_t len, uint32_t nowMs);
|
||||
void chunkWritten(bool ok, uint32_t nowMs);
|
||||
void finished(bool ok);
|
||||
void tick(uint32_t nowMs);
|
||||
void reset() { *this = FileReceiver(); }
|
||||
|
||||
State state() const { return state_; }
|
||||
bool active() const { return state_ != State::Idle; }
|
||||
// Bytes still missing from the current chunk: read no more than this from the serial port.
|
||||
size_t wanted() const;
|
||||
const std::vector<uint8_t>& chunk() const { return chunk_; }
|
||||
const std::string& path() const { return path_; }
|
||||
std::string partPath() const { return path_ + ".part"; }
|
||||
uint32_t size() const { return size_; }
|
||||
uint32_t received() const { return received_; }
|
||||
const std::string& error() const { return error_; }
|
||||
|
||||
private:
|
||||
void fail(const char* why);
|
||||
|
||||
State state_ = State::Idle;
|
||||
std::string path_;
|
||||
uint32_t size_ = 0;
|
||||
uint32_t received_ = 0; // bytes in chunks already written
|
||||
uint8_t expected_[32] = {};
|
||||
Sha256 sha_;
|
||||
std::vector<uint8_t> chunk_;
|
||||
uint32_t lastActivityMs_ = 0;
|
||||
std::string error_;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,28 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Decides when new firmware on Probation (see CONTEXT.md) has proven healthy, or has failed in a
|
||||
// way that would leave no means to push a fix (Wi-Fi configured but never connecting).
|
||||
class Probation {
|
||||
public:
|
||||
enum class Verdict { Wait, Confirm, RollBack };
|
||||
static constexpr uint32_t kHealthyAfterMs = 30000;
|
||||
static constexpr uint32_t kWifiDeadlineMs = 180000;
|
||||
|
||||
// Checked first thing at boot, before anything that could crash. `attemptsBefore` counts earlier
|
||||
// boots of this image on Probation; a second start means the first one died before confirming.
|
||||
// (A second line behind the bootloader's own rollback, which aborts an image still pending.)
|
||||
static bool rollBackAtBoot(bool onProbation, int attemptsBefore) { return onProbation && attemptsBefore >= 1; }
|
||||
|
||||
static Verdict judge(uint32_t uptimeMs, bool firstFrameDrawn, bool wifiConfigured, bool wifiConnected) {
|
||||
if (wifiConfigured && !wifiConnected && uptimeMs >= kWifiDeadlineMs) return Verdict::RollBack;
|
||||
if (uptimeMs < kHealthyAfterMs || !firstFrameDrawn) return Verdict::Wait;
|
||||
if (wifiConfigured && !wifiConnected) return Verdict::Wait;
|
||||
return Verdict::Confirm;
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,21 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Safe Mode (CONTEXT.md): after kCrashLimit starts in a row that ended in a crash, the firmware
|
||||
// starts only what it takes to be fixed over the air (Wi-Fi, Firmware Updates, the Debug Console).
|
||||
// Rollback covers new firmware; this covers firmware that was confirmed and crashes anyway.
|
||||
struct SafeMode {
|
||||
static constexpr int kCrashLimit = 3;
|
||||
static constexpr uint32_t kStableAfterMs = 60000; // then the count starts over
|
||||
|
||||
// Called first thing at boot with the count so far; returns the new count.
|
||||
static int countAtBoot(bool lastStartWasCrash, int crashesBefore) {
|
||||
return lastStartWasCrash ? crashesBefore + 1 : 0;
|
||||
}
|
||||
static bool active(int crashes) { return crashes >= kCrashLimit; }
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,85 +0,0 @@
|
||||
#include "sha256.h"
|
||||
|
||||
#include <cstring>
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
const uint32_t K[64] = {
|
||||
0x428a2f98, 0x71374491, 0xb5c0fbcf, 0xe9b5dba5, 0x3956c25b, 0x59f111f1, 0x923f82a4, 0xab1c5ed5,
|
||||
0xd807aa98, 0x12835b01, 0x243185be, 0x550c7dc3, 0x72be5d74, 0x80deb1fe, 0x9bdc06a7, 0xc19bf174,
|
||||
0xe49b69c1, 0xefbe4786, 0x0fc19dc6, 0x240ca1cc, 0x2de92c6f, 0x4a7484aa, 0x5cb0a9dc, 0x76f988da,
|
||||
0x983e5152, 0xa831c66d, 0xb00327c8, 0xbf597fc7, 0xc6e00bf3, 0xd5a79147, 0x06ca6351, 0x14292967,
|
||||
0x27b70a85, 0x2e1b2138, 0x4d2c6dfc, 0x53380d13, 0x650a7354, 0x766a0abb, 0x81c2c92e, 0x92722c85,
|
||||
0xa2bfe8a1, 0xa81a664b, 0xc24b8b70, 0xc76c51a3, 0xd192e819, 0xd6990624, 0xf40e3585, 0x106aa070,
|
||||
0x19a4c116, 0x1e376c08, 0x2748774c, 0x34b0bcb5, 0x391c0cb3, 0x4ed8aa4a, 0x5b9cca4f, 0x682e6ff3,
|
||||
0x748f82ee, 0x78a5636f, 0x84c87814, 0x8cc70208, 0x90befffa, 0xa4506ceb, 0xbef9a3f7, 0xc67178f2};
|
||||
|
||||
inline uint32_t rotr(uint32_t x, int n) { return (x >> n) | (x << (32 - n)); }
|
||||
} // namespace
|
||||
|
||||
Sha256::Sha256() {
|
||||
const uint32_t init[8] = {0x6a09e667, 0xbb67ae85, 0x3c6ef372, 0xa54ff53a,
|
||||
0x510e527f, 0x9b05688c, 0x1f83d9ab, 0x5be0cd19};
|
||||
std::memcpy(h_, init, sizeof(h_));
|
||||
}
|
||||
|
||||
void Sha256::block(const uint8_t* p) {
|
||||
uint32_t w[64];
|
||||
for (int i = 0; i < 16; i++)
|
||||
w[i] = (uint32_t(p[4 * i]) << 24) | (uint32_t(p[4 * i + 1]) << 16) | (uint32_t(p[4 * i + 2]) << 8) | p[4 * i + 3];
|
||||
for (int i = 16; i < 64; i++) {
|
||||
uint32_t s0 = rotr(w[i - 15], 7) ^ rotr(w[i - 15], 18) ^ (w[i - 15] >> 3);
|
||||
uint32_t s1 = rotr(w[i - 2], 17) ^ rotr(w[i - 2], 19) ^ (w[i - 2] >> 10);
|
||||
w[i] = w[i - 16] + s0 + w[i - 7] + s1;
|
||||
}
|
||||
uint32_t a = h_[0], b = h_[1], c = h_[2], d = h_[3], e = h_[4], f = h_[5], g = h_[6], h = h_[7];
|
||||
for (int i = 0; i < 64; i++) {
|
||||
uint32_t t1 = h + (rotr(e, 6) ^ rotr(e, 11) ^ rotr(e, 25)) + ((e & f) ^ (~e & g)) + K[i] + w[i];
|
||||
uint32_t t2 = (rotr(a, 2) ^ rotr(a, 13) ^ rotr(a, 22)) + ((a & b) ^ (a & c) ^ (b & c));
|
||||
h = g;
|
||||
g = f;
|
||||
f = e;
|
||||
e = d + t1;
|
||||
d = c;
|
||||
c = b;
|
||||
b = a;
|
||||
a = t1 + t2;
|
||||
}
|
||||
h_[0] += a; h_[1] += b; h_[2] += c; h_[3] += d;
|
||||
h_[4] += e; h_[5] += f; h_[6] += g; h_[7] += h;
|
||||
}
|
||||
|
||||
void Sha256::update(const uint8_t* data, size_t len) {
|
||||
bits_ += static_cast<uint64_t>(len) * 8;
|
||||
while (len > 0) {
|
||||
size_t take = 64 - used_ < len ? 64 - used_ : len;
|
||||
std::memcpy(buf_ + used_, data, take);
|
||||
used_ += take;
|
||||
data += take;
|
||||
len -= take;
|
||||
if (used_ == 64) {
|
||||
block(buf_);
|
||||
used_ = 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void Sha256::finish(uint8_t out[32]) {
|
||||
uint64_t bits = bits_;
|
||||
uint8_t pad = 0x80;
|
||||
update(&pad, 1);
|
||||
uint8_t zero = 0;
|
||||
while (used_ != 56) update(&zero, 1);
|
||||
uint8_t len[8];
|
||||
for (int i = 0; i < 8; i++) len[i] = static_cast<uint8_t>(bits >> (56 - 8 * i));
|
||||
update(len, 8);
|
||||
for (int i = 0; i < 8; i++) {
|
||||
out[4 * i] = h_[i] >> 24;
|
||||
out[4 * i + 1] = h_[i] >> 16;
|
||||
out[4 * i + 2] = h_[i] >> 8;
|
||||
out[4 * i + 3] = h_[i];
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,30 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Plain SHA-256 (FIPS 180-4), streaming. Small and dependency-free, so the same code runs in the
|
||||
// PC tests and on the device.
|
||||
class Sha256 {
|
||||
public:
|
||||
Sha256();
|
||||
void update(const uint8_t* data, size_t len);
|
||||
void finish(uint8_t out[32]);
|
||||
|
||||
static void hash(const uint8_t* data, size_t len, uint8_t out[32]) {
|
||||
Sha256 s;
|
||||
s.update(data, len);
|
||||
s.finish(out);
|
||||
}
|
||||
|
||||
private:
|
||||
void block(const uint8_t* p);
|
||||
uint32_t h_[8];
|
||||
uint8_t buf_[64];
|
||||
size_t used_ = 0;
|
||||
uint64_t bits_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,87 +0,0 @@
|
||||
#include "update_parser.h"
|
||||
|
||||
#include <cstring>
|
||||
|
||||
#include "version_compare.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
uint16_t u16(const uint8_t* p) { return p[0] | (p[1] << 8); }
|
||||
uint32_t u32(const uint8_t* p) { return p[0] | (p[1] << 8) | (p[2] << 16) | (uint32_t(p[3]) << 24); }
|
||||
} // namespace
|
||||
|
||||
void UpdateParser::fail(const std::string& why) {
|
||||
if (state_ == State::Image) sink_.abort();
|
||||
state_ = State::Failed;
|
||||
error_ = why;
|
||||
}
|
||||
|
||||
void UpdateParser::parseHeader() {
|
||||
const uint8_t* h = header_;
|
||||
if (std::memcmp(h, update::kMagic, 8) != 0) return fail("not an update file");
|
||||
if (u16(h + 8) != update::kFormat || u16(h + 10) != update::kHeaderSize) return fail("unsupported update format");
|
||||
imageSize_ = u32(h + 12);
|
||||
if (imageSize_ == 0 || imageSize_ > maxImage_) return fail("image doesn't fit the update slot");
|
||||
std::memcpy(expectedHash_, h + 16, 32);
|
||||
version_.assign(reinterpret_cast<const char*>(h + 48), strnlen(reinterpret_cast<const char*>(h + 48), 32));
|
||||
|
||||
size_t sigLen = u16(h + 80);
|
||||
if (sigLen == 0 || sigLen > update::kMaxSignature) return fail("missing signature");
|
||||
uint8_t digest[32];
|
||||
Sha256::hash(h, update::kSignedBytes, digest);
|
||||
if (!verifier_.verify(digest, h + 82, sigLen)) return fail("bad signature (wrong key)");
|
||||
|
||||
downgrade_ = versionOlder(version_, installed_);
|
||||
if (!sink_.begin(imageSize_)) return fail("could not prepare the update slot");
|
||||
state_ = State::Image;
|
||||
}
|
||||
|
||||
void UpdateParser::feed(const uint8_t* data, size_t len) {
|
||||
while (len > 0 && (state_ == State::Header || state_ == State::Image)) {
|
||||
if (state_ == State::Header) {
|
||||
size_t take = std::min(len, update::kHeaderSize - headerUsed_);
|
||||
std::memcpy(header_ + headerUsed_, data, take);
|
||||
headerUsed_ += take;
|
||||
data += take;
|
||||
len -= take;
|
||||
if (headerUsed_ == update::kHeaderSize) parseHeader();
|
||||
} else {
|
||||
size_t take = std::min(len, imageSize_ - received_);
|
||||
if (take == 0) return fail("data after the end of the image");
|
||||
hash_.update(data, take);
|
||||
if (!sink_.write(data, take)) return fail("writing the update failed");
|
||||
received_ += take;
|
||||
data += take;
|
||||
len -= take;
|
||||
}
|
||||
}
|
||||
if (len > 0 && state_ == State::Image) fail("data after the end of the image");
|
||||
}
|
||||
|
||||
bool UpdateParser::end() {
|
||||
if (state_ == State::Done) return true;
|
||||
if (state_ != State::Image) {
|
||||
if (state_ == State::Header) fail("update file too short");
|
||||
return false;
|
||||
}
|
||||
if (received_ != imageSize_) {
|
||||
fail("update file too short");
|
||||
return false;
|
||||
}
|
||||
uint8_t got[32];
|
||||
hash_.finish(got);
|
||||
if (std::memcmp(got, expectedHash_, 32) != 0) {
|
||||
fail("image corrupted (hash mismatch)");
|
||||
return false;
|
||||
}
|
||||
if (!sink_.finish()) {
|
||||
state_ = State::Failed;
|
||||
error_ = "could not switch to the new image";
|
||||
return false;
|
||||
}
|
||||
state_ = State::Done;
|
||||
return true;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,82 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
|
||||
#include "sha256.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// The Update File (see CONTEXT.md): a 160-byte header, then the firmware image. All integers are
|
||||
// little-endian.
|
||||
// 0 magic "RORO-OTA" 8 u16 format (1) 10 u16 header size (160) 12 u32 image size
|
||||
// 16 image SHA-256[32] 48 version, NUL-padded [32]
|
||||
// 80 u16 signature length 82 signature (DER, up to 72 bytes) 154 reserved
|
||||
// The signature covers SHA-256 of bytes 0..79, which include the image's hash, so a bad signature
|
||||
// is caught before anything is written, and a bad image when its hash is checked at the end.
|
||||
namespace update {
|
||||
constexpr char kMagic[] = "RORO-OTA";
|
||||
constexpr uint16_t kFormat = 1;
|
||||
constexpr size_t kHeaderSize = 160;
|
||||
constexpr size_t kSignedBytes = 80;
|
||||
constexpr size_t kMaxSignature = 72;
|
||||
} // namespace update
|
||||
|
||||
class SignatureVerifier {
|
||||
public:
|
||||
virtual ~SignatureVerifier() = default;
|
||||
virtual bool verify(const uint8_t digest[32], const uint8_t* signature, size_t len) = 0;
|
||||
};
|
||||
|
||||
// Where the image goes (the inactive app slot on the device).
|
||||
class UpdateSink {
|
||||
public:
|
||||
virtual ~UpdateSink() = default;
|
||||
virtual bool begin(size_t imageSize) = 0;
|
||||
virtual bool write(const uint8_t* data, size_t len) = 0;
|
||||
virtual bool finish() = 0; // make it the image to boot next
|
||||
virtual void abort() = 0;
|
||||
};
|
||||
|
||||
// Streams an Update File into a sink: checks the header and signature first, then hashes the image
|
||||
// as it passes through, and only finishes the sink if everything matches.
|
||||
class UpdateParser {
|
||||
public:
|
||||
enum class State { Header, Image, Done, Failed };
|
||||
|
||||
UpdateParser(SignatureVerifier& verifier, UpdateSink& sink, size_t maxImageSize, std::string installedVersion)
|
||||
: verifier_(verifier), sink_(sink), maxImage_(maxImageSize), installed_(std::move(installedVersion)) {}
|
||||
|
||||
void feed(const uint8_t* data, size_t len);
|
||||
bool end(); // no more data: true if the update was installed
|
||||
// The whole image the header announced has arrived (the sender need not close the connection).
|
||||
bool complete() const { return state_ == State::Image && received_ == imageSize_; }
|
||||
|
||||
State state() const { return state_; }
|
||||
const std::string& error() const { return error_; }
|
||||
const std::string& version() const { return version_; }
|
||||
bool isDowngrade() const { return downgrade_; }
|
||||
int percent() const { return imageSize_ ? static_cast<int>(received_ * 100 / imageSize_) : 0; }
|
||||
|
||||
private:
|
||||
void parseHeader();
|
||||
void fail(const std::string& why);
|
||||
|
||||
SignatureVerifier& verifier_;
|
||||
UpdateSink& sink_;
|
||||
size_t maxImage_;
|
||||
std::string installed_;
|
||||
|
||||
State state_ = State::Header;
|
||||
uint8_t header_[update::kHeaderSize];
|
||||
size_t headerUsed_ = 0;
|
||||
uint8_t expectedHash_[32];
|
||||
size_t imageSize_ = 0;
|
||||
size_t received_ = 0;
|
||||
Sha256 hash_;
|
||||
std::string version_, error_;
|
||||
bool downgrade_ = false;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,33 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdlib>
|
||||
#include <string>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// True if `a` is an older release than `b`, comparing "vMAJOR.MINOR.PATCH" and ignoring any
|
||||
// git-describe suffix ("-3-gabc1234-dirty"). Anything that doesn't parse is never called older.
|
||||
inline bool parseVersion(const std::string& s, int out[3]) {
|
||||
size_t pos = s.size() > 0 && s[0] == 'v' ? 1 : 0;
|
||||
for (int i = 0; i < 3; i++) {
|
||||
if (pos >= s.size() || s[pos] < '0' || s[pos] > '9') return false;
|
||||
char* end;
|
||||
out[i] = static_cast<int>(std::strtol(s.c_str() + pos, &end, 10));
|
||||
pos = end - s.c_str();
|
||||
if (i < 2) {
|
||||
if (pos >= s.size() || s[pos] != '.') return false;
|
||||
pos++;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
inline bool versionOlder(const std::string& a, const std::string& b) {
|
||||
int x[3], y[3];
|
||||
if (!parseVersion(a, x) || !parseVersion(b, y)) return false;
|
||||
for (int i = 0; i < 3; i++)
|
||||
if (x[i] != y[i]) return x[i] < y[i];
|
||||
return false;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,49 +0,0 @@
|
||||
#include "battery_estimator.h"
|
||||
|
||||
#include <algorithm>
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
struct Point {
|
||||
int millivolts;
|
||||
int percent;
|
||||
};
|
||||
const Point kCurve[] = {
|
||||
{3270, 0}, {3610, 5}, {3690, 10}, {3710, 15}, {3730, 20}, {3750, 25}, {3770, 30},
|
||||
{3790, 35}, {3800, 40}, {3820, 45}, {3840, 50}, {3850, 55}, {3870, 60}, {3910, 65},
|
||||
{3950, 70}, {3980, 75}, {4020, 80}, {4080, 85}, {4110, 90}, {4150, 95}, {4200, 100},
|
||||
};
|
||||
const size_t kPoints = sizeof(kCurve) / sizeof(kCurve[0]);
|
||||
} // namespace
|
||||
|
||||
int BatteryEstimator::percentFromMillivolts(int mv) {
|
||||
if (mv <= kCurve[0].millivolts) return 0;
|
||||
if (mv >= kCurve[kPoints - 1].millivolts) return 100;
|
||||
for (size_t i = 1; i < kPoints; i++) {
|
||||
if (mv <= kCurve[i].millivolts) {
|
||||
const auto& lo = kCurve[i - 1];
|
||||
const auto& hi = kCurve[i];
|
||||
return lo.percent + (mv - lo.millivolts) * (hi.percent - lo.percent) /
|
||||
(hi.millivolts - lo.millivolts);
|
||||
}
|
||||
}
|
||||
return 100;
|
||||
}
|
||||
|
||||
void BatteryEstimator::addSample(int mv) {
|
||||
samples_[next_] = mv;
|
||||
next_ = (next_ + 1) % kWindow;
|
||||
if (count_ < kWindow) count_++;
|
||||
}
|
||||
|
||||
int BatteryEstimator::millivolts() const {
|
||||
if (count_ == 0) return 0;
|
||||
// Median: ignores short sags (radio transmit bursts) that would drag an average down.
|
||||
std::array<int, kWindow> sorted = samples_;
|
||||
auto middle = sorted.begin() + count_ / 2;
|
||||
std::nth_element(sorted.begin(), middle, sorted.begin() + count_);
|
||||
return *middle;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,27 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <array>
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Smooths battery voltage samples and turns them into a charge percentage.
|
||||
class BatteryEstimator {
|
||||
public:
|
||||
// Typical single-cell LiPo discharge curve under light load.
|
||||
static int percentFromMillivolts(int millivolts);
|
||||
|
||||
void addSample(int millivolts);
|
||||
bool hasReading() const { return count_ > 0; }
|
||||
int millivolts() const; // median of the recent samples
|
||||
int percent() const { return percentFromMillivolts(millivolts()); }
|
||||
|
||||
private:
|
||||
static constexpr size_t kWindow = 8;
|
||||
std::array<int, kWindow> samples_{};
|
||||
size_t next_ = 0;
|
||||
size_t count_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,24 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
namespace roro {
|
||||
|
||||
struct Choice {
|
||||
const char* label;
|
||||
const char* value;
|
||||
};
|
||||
|
||||
// Timezones offered in Settings and the setup wizard (POSIX TZ strings).
|
||||
inline const Choice kTimezones[] = {
|
||||
{"Brussels", "CET-1CEST,M3.5.0,M10.5.0/3"}, // also Paris, Amsterdam, Berlin...
|
||||
{"London", "GMT0BST,M3.5.0/1,M10.5.0"},
|
||||
{"Lisbon", "WET0WEST,M3.5.0/1,M10.5.0"},
|
||||
{"Helsinki", "EET-2EEST,M3.5.0/3,M10.5.0/4"},
|
||||
{"UTC", "UTC0"},
|
||||
};
|
||||
|
||||
// Regions the radio may be used in (see Region in CONTEXT.md).
|
||||
inline const Choice kRegions[] = {
|
||||
{"EU868 (Europe, 869.5 MHz)", "EU868"},
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,58 +0,0 @@
|
||||
#include "clock_model.h"
|
||||
|
||||
#include <cstdio>
|
||||
#include <cstdlib>
|
||||
#include <ctime>
|
||||
|
||||
namespace roro {
|
||||
|
||||
bool ClockModel::set(int64_t utcSeconds, TimeSource source, uint32_t nowMs) {
|
||||
if (source < source_) return false;
|
||||
source_ = source;
|
||||
utcAtSet_ = utcSeconds;
|
||||
msAtSet_ = nowMs;
|
||||
return true;
|
||||
}
|
||||
|
||||
int64_t ClockModel::utcNow(uint32_t nowMs) const {
|
||||
// Unsigned subtraction handles the millis() wraparound. Uptime beyond 49 days between two
|
||||
// sets would lose 49 days; sources refresh far more often than that.
|
||||
return utcAtSet_ + static_cast<int64_t>(static_cast<uint32_t>(nowMs - msAtSet_) / 1000);
|
||||
}
|
||||
|
||||
void ClockModel::applyTimezone(const char* posixTz) {
|
||||
setenv("TZ", posixTz, 1);
|
||||
tzset();
|
||||
}
|
||||
|
||||
std::string ClockModel::formatLocalTime(int64_t utcSeconds) {
|
||||
time_t t = static_cast<time_t>(utcSeconds);
|
||||
struct tm local;
|
||||
localtime_r(&t, &local);
|
||||
char buf[8];
|
||||
std::snprintf(buf, sizeof(buf), "%02d:%02d", local.tm_hour, local.tm_min);
|
||||
return buf;
|
||||
}
|
||||
|
||||
std::string ClockModel::formatLocalDate(int64_t utcSeconds) {
|
||||
time_t t = static_cast<time_t>(utcSeconds);
|
||||
struct tm local;
|
||||
localtime_r(&t, &local);
|
||||
char buf[12];
|
||||
std::snprintf(buf, sizeof(buf), "%04d-%02d-%02d", local.tm_year + 1900, local.tm_mon + 1, local.tm_mday);
|
||||
return buf;
|
||||
}
|
||||
|
||||
std::string ClockModel::formatAge(int64_t seconds) {
|
||||
char buf[24];
|
||||
if (seconds < 60) return "now";
|
||||
if (seconds < 3600)
|
||||
std::snprintf(buf, sizeof(buf), "%d min ago", static_cast<int>(seconds / 60));
|
||||
else if (seconds < 86400)
|
||||
std::snprintf(buf, sizeof(buf), "%d h ago", static_cast<int>(seconds / 3600));
|
||||
else
|
||||
std::snprintf(buf, sizeof(buf), "%d d ago", static_cast<int>(seconds / 86400));
|
||||
return buf;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,33 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Ordered by trust: a source can only replace the time set by an equal or less trusted one.
|
||||
enum class TimeSource : uint8_t { None, Mesh, Ntp, Gnss };
|
||||
|
||||
// Wall-clock time on a device with no battery-backed clock: unset until a TimeSource provides
|
||||
// it, then advanced from uptime. Stored in UTC; local display uses the POSIX TZ applied globally.
|
||||
class ClockModel {
|
||||
public:
|
||||
// Returns false if a more trusted source already set the time.
|
||||
bool set(int64_t utcSeconds, TimeSource source, uint32_t nowMs);
|
||||
|
||||
bool isSet() const { return source_ != TimeSource::None; }
|
||||
TimeSource source() const { return source_; }
|
||||
int64_t utcNow(uint32_t nowMs) const;
|
||||
|
||||
static void applyTimezone(const char* posixTz);
|
||||
static std::string formatLocalTime(int64_t utcSeconds); // "HH:MM"
|
||||
static std::string formatLocalDate(int64_t utcSeconds); // "YYYY-MM-DD"
|
||||
static std::string formatAge(int64_t seconds); // "now", "5 min ago", "3 h ago", "2 d ago"
|
||||
|
||||
private:
|
||||
TimeSource source_ = TimeSource::None;
|
||||
int64_t utcAtSet_ = 0;
|
||||
uint32_t msAtSet_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,18 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Persistent key/value storage (NVS on the device, a map in tests). Keys are at most 15 chars.
|
||||
class KeyValueStore {
|
||||
public:
|
||||
virtual ~KeyValueStore() = default;
|
||||
virtual bool getInt(const char* key, int32_t& out) = 0;
|
||||
virtual bool getString(const char* key, std::string& out) = 0;
|
||||
virtual void putInt(const char* key, int32_t value) = 0;
|
||||
virtual void putString(const char* key, const std::string& value) = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,42 +0,0 @@
|
||||
#include "power_policy.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
bool PowerPolicy::activity(uint32_t nowMs) {
|
||||
bool swallow = state_ == ScreenState::Off;
|
||||
lastActivityMs_ = nowMs;
|
||||
state_ = ScreenState::On;
|
||||
return swallow;
|
||||
}
|
||||
|
||||
ScreenState PowerPolicy::update(uint32_t nowMs) {
|
||||
uint32_t idle = nowMs - lastActivityMs_;
|
||||
state_ = idle >= offMs_ ? ScreenState::Off : idle >= dimMs_ ? ScreenState::Dimmed : ScreenState::On;
|
||||
if (notifying_) {
|
||||
if (static_cast<int32_t>(nowMs - notifyUntilMs_) >= 0)
|
||||
notifying_ = false;
|
||||
else if (state_ == ScreenState::Off)
|
||||
state_ = ScreenState::Dimmed;
|
||||
}
|
||||
return state_;
|
||||
}
|
||||
|
||||
ButtonAction PowerButton::update(bool pressed, uint32_t nowMs) {
|
||||
if (pressed && !pressed_) {
|
||||
pressed_ = true;
|
||||
longFired_ = false;
|
||||
pressedAtMs_ = nowMs;
|
||||
return ButtonAction::None;
|
||||
}
|
||||
if (pressed && !longFired_ && nowMs - pressedAtMs_ >= longMs_) {
|
||||
longFired_ = true;
|
||||
return ButtonAction::LongPress;
|
||||
}
|
||||
if (!pressed && pressed_) {
|
||||
pressed_ = false;
|
||||
return longFired_ ? ButtonAction::None : ButtonAction::ShortPress;
|
||||
}
|
||||
return ButtonAction::None;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,57 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
|
||||
namespace roro {
|
||||
|
||||
enum class ScreenState : uint8_t { On, Dimmed, Off };
|
||||
|
||||
// Screen power from user activity. Services keep running whatever the screen does.
|
||||
class PowerPolicy {
|
||||
public:
|
||||
PowerPolicy(uint32_t dimAfterMs, uint32_t offAfterMs) : dimMs_(dimAfterMs), offMs_(offAfterMs) {}
|
||||
|
||||
void setTimeouts(uint32_t dimAfterMs, uint32_t offAfterMs) {
|
||||
dimMs_ = dimAfterMs;
|
||||
offMs_ = offAfterMs;
|
||||
}
|
||||
|
||||
// Records a key press. Returns true if the key only woke an Off screen and must not reach the App.
|
||||
bool activity(uint32_t nowMs);
|
||||
|
||||
// A Notification is showing until untilMs: an Off screen lights up Dimmed meanwhile. It's not
|
||||
// user activity, so it doesn't restart the timeouts.
|
||||
void notify(uint32_t nowMs, uint32_t untilMs) {
|
||||
(void)nowMs;
|
||||
notifyUntilMs_ = untilMs;
|
||||
notifying_ = true;
|
||||
}
|
||||
|
||||
ScreenState update(uint32_t nowMs);
|
||||
ScreenState state() const { return state_; }
|
||||
|
||||
private:
|
||||
uint32_t dimMs_;
|
||||
uint32_t offMs_;
|
||||
uint32_t lastActivityMs_ = 0;
|
||||
uint32_t notifyUntilMs_ = 0;
|
||||
bool notifying_ = false;
|
||||
ScreenState state_ = ScreenState::On;
|
||||
};
|
||||
|
||||
enum class ButtonAction : uint8_t { None, ShortPress, LongPress };
|
||||
|
||||
// G0 button: a long press fires as soon as the hold time is reached (power off); a short press on release.
|
||||
class PowerButton {
|
||||
public:
|
||||
explicit PowerButton(uint32_t longPressMs) : longMs_(longPressMs) {}
|
||||
ButtonAction update(bool pressed, uint32_t nowMs);
|
||||
|
||||
private:
|
||||
uint32_t longMs_;
|
||||
bool pressed_ = false;
|
||||
bool longFired_ = false;
|
||||
uint32_t pressedAtMs_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,121 +0,0 @@
|
||||
#include "settings.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
|
||||
enum class Kind : uint8_t { Bool, Int, String };
|
||||
|
||||
struct Definition {
|
||||
const char* key;
|
||||
Kind kind;
|
||||
int32_t defaultInt;
|
||||
const char* defaultString;
|
||||
int32_t min;
|
||||
int32_t max; // for strings: max length in bytes
|
||||
};
|
||||
|
||||
// Order must match the Setting enum.
|
||||
const Definition kDefinitions[] = {
|
||||
{"setup_done", Kind::Bool, 0, nullptr, 0, 1},
|
||||
{"long_name", Kind::String, 0, "", 1, 39},
|
||||
{"short_name", Kind::String, 0, "", 1, 4},
|
||||
{"region", Kind::String, 0, "EU868", 1, 8},
|
||||
{"region_ok", Kind::Bool, 0, nullptr, 0, 1},
|
||||
{"timezone", Kind::String, 0, "CET-1CEST,M3.5.0,M10.5.0/3", 1, 63},
|
||||
{"brightness", Kind::Int, 60, nullptr, 10, 100},
|
||||
{"dim_s", Kind::Int, 30, nullptr, 5, 600},
|
||||
{"off_s", Kind::Int, 60, nullptr, 10, 3600},
|
||||
{"sound", Kind::Bool, 1, nullptr, 0, 1},
|
||||
{"probe_mac_raw", Kind::Bool, 1, nullptr, 0, 1},
|
||||
{"wifi_on", Kind::Bool, 1, nullptr, 0, 1},
|
||||
{"gnss_on", Kind::Bool, 1, nullptr, 0, 1},
|
||||
{"coord_dms", Kind::Bool, 0, nullptr, 0, 1},
|
||||
};
|
||||
static_assert(sizeof(kDefinitions) / sizeof(kDefinitions[0]) == static_cast<size_t>(Setting::Count),
|
||||
"every Setting needs a definition");
|
||||
|
||||
const char* const kKnownRegions[] = {"EU868"};
|
||||
|
||||
const Definition& def(Setting s) { return kDefinitions[static_cast<size_t>(s)]; }
|
||||
|
||||
} // namespace
|
||||
|
||||
Settings::Settings(KeyValueStore& store, EventBus& bus) : store_(store), bus_(bus) {}
|
||||
|
||||
const char* Settings::key(Setting s) { return def(s).key; }
|
||||
|
||||
void Settings::load() {
|
||||
for (size_t i = 0; i < values_.size(); i++) {
|
||||
auto s = static_cast<Setting>(i);
|
||||
const auto& d = def(s);
|
||||
auto& v = values_[i];
|
||||
if (d.kind == Kind::String) {
|
||||
v.str = d.defaultString;
|
||||
std::string stored;
|
||||
if (store_.getString(d.key, stored) && validString(s, stored)) v.str = stored;
|
||||
} else {
|
||||
v.i = d.defaultInt;
|
||||
int32_t stored;
|
||||
if (store_.getInt(d.key, stored) && validInt(s, stored)) v.i = stored;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
int32_t Settings::getInt(Setting s) const { return values_[static_cast<size_t>(s)].i; }
|
||||
bool Settings::getBool(Setting s) const { return getInt(s) != 0; }
|
||||
const std::string& Settings::getString(Setting s) const { return values_[static_cast<size_t>(s)].str; }
|
||||
|
||||
bool Settings::validInt(Setting s, int32_t value) const {
|
||||
const auto& d = def(s);
|
||||
if (d.kind == Kind::String || value < d.min || value > d.max) return false;
|
||||
if (s == Setting::DimTimeoutS) return value < getInt(Setting::OffTimeoutS);
|
||||
if (s == Setting::OffTimeoutS) return value > getInt(Setting::DimTimeoutS);
|
||||
return true;
|
||||
}
|
||||
|
||||
bool Settings::validString(Setting s, const std::string& value) const {
|
||||
const auto& d = def(s);
|
||||
if (d.kind != Kind::String) return false;
|
||||
if (value.size() < static_cast<size_t>(d.min) || value.size() > static_cast<size_t>(d.max)) return false;
|
||||
if (s == Setting::Region) {
|
||||
for (auto region : kKnownRegions)
|
||||
if (value == region) return true;
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool Settings::setInt(Setting s, int32_t value) {
|
||||
if (def(s).kind == Kind::Bool) return false;
|
||||
if (!validInt(s, value)) return false;
|
||||
if (getInt(s) == value) return true;
|
||||
values_[static_cast<size_t>(s)].i = value;
|
||||
store_.putInt(key(s), value);
|
||||
changed(s);
|
||||
return true;
|
||||
}
|
||||
|
||||
bool Settings::setBool(Setting s, bool value) {
|
||||
if (def(s).kind != Kind::Bool) return false;
|
||||
if (getBool(s) == value) return true;
|
||||
values_[static_cast<size_t>(s)].i = value ? 1 : 0;
|
||||
store_.putInt(key(s), value ? 1 : 0);
|
||||
changed(s);
|
||||
return true;
|
||||
}
|
||||
|
||||
bool Settings::setString(Setting s, const std::string& value) {
|
||||
if (!validString(s, value)) return false;
|
||||
if (getString(s) == value) return true;
|
||||
values_[static_cast<size_t>(s)].str = value;
|
||||
store_.putString(key(s), value);
|
||||
changed(s);
|
||||
return true;
|
||||
}
|
||||
|
||||
void Settings::changed(Setting s) {
|
||||
bus_.publish(Event::withText(EventType::SettingChanged, key(s), static_cast<int32_t>(s)));
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,65 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <array>
|
||||
#include <string>
|
||||
|
||||
#include "event_bus.h"
|
||||
#include "key_value_store.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
enum class Setting : uint8_t {
|
||||
SetupDone, // bool: first-boot wizard completed
|
||||
LongName, // string, 1..39 bytes
|
||||
ShortName, // string, 1..4 bytes
|
||||
Region, // string, a known Region ("EU868")
|
||||
RegionConfirmed, // bool: nothing transmits until true
|
||||
Timezone, // string, POSIX TZ
|
||||
Brightness, // int, 10..100 %
|
||||
DimTimeoutS, // int, 5..600, below OffTimeoutS
|
||||
OffTimeoutS, // int, 10..3600, above DimTimeoutS
|
||||
Sound, // bool
|
||||
ProbeMacRaw, // bool: probe-request Logs keep raw MAC addresses
|
||||
WifiEnabled, // bool: the Wi-Fi Service stays Connected when a Saved Network is in range
|
||||
GnssEnabled, // bool: the GNSS Service reads the receiver (M2, Q58)
|
||||
CoordinatesDms, // bool: show degrees, minutes and seconds instead of decimal degrees (Q64)
|
||||
Count
|
||||
};
|
||||
|
||||
// Typed, validated settings in internal flash. Every accepted change is persisted immediately and
|
||||
// announced with a SettingChanged event; rejected values leave the current value untouched.
|
||||
class Settings {
|
||||
public:
|
||||
Settings(KeyValueStore& store, EventBus& bus);
|
||||
|
||||
// Reads every setting; missing or invalid stored values fall back to defaults.
|
||||
void load();
|
||||
|
||||
int32_t getInt(Setting s) const;
|
||||
bool getBool(Setting s) const;
|
||||
const std::string& getString(Setting s) const;
|
||||
|
||||
bool setInt(Setting s, int32_t value);
|
||||
bool setBool(Setting s, bool value);
|
||||
bool setString(Setting s, const std::string& value);
|
||||
|
||||
bool canTransmit() const { return getBool(Setting::RegionConfirmed); }
|
||||
|
||||
static const char* key(Setting s);
|
||||
|
||||
private:
|
||||
struct Value {
|
||||
int32_t i = 0;
|
||||
std::string str;
|
||||
};
|
||||
|
||||
bool validInt(Setting s, int32_t value) const;
|
||||
bool validString(Setting s, const std::string& value) const;
|
||||
void changed(Setting s);
|
||||
|
||||
KeyValueStore& store_;
|
||||
EventBus& bus_;
|
||||
std::array<Value, static_cast<size_t>(Setting::Count)> values_;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,32 +0,0 @@
|
||||
#include "storage_monitor.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
void StorageMonitor::update(bool present, uint64_t totalBytes, uint64_t usedBytes) {
|
||||
StorageState next;
|
||||
next.present = present && totalBytes > 0;
|
||||
if (next.present) {
|
||||
next.totalBytes = totalBytes;
|
||||
next.usedBytes = usedBytes;
|
||||
next.usedPercent = static_cast<int>(usedBytes * 100 / totalBytes);
|
||||
bool full = totalBytes - usedBytes < kFullReserveBytes || usedBytes >= totalBytes;
|
||||
next.level = full ? 100 : next.usedPercent >= 90 ? 90 : next.usedPercent >= 80 ? 80 : 0;
|
||||
next.logsAllowed = next.level < 90;
|
||||
next.capturesAllowed = next.level < 100;
|
||||
}
|
||||
|
||||
bool levelChanged = next.present && (next.level != state_.level || !state_.present);
|
||||
bool firstReading = !state_.present;
|
||||
state_ = next;
|
||||
|
||||
if (levelChanged && !(firstReading && next.level == 0))
|
||||
bus_.publish(Event::withValues(EventType::StorageThreshold, next.usedPercent, next.level));
|
||||
|
||||
if (next.present && next.level >= 80 && !warned_) {
|
||||
warned_ = true;
|
||||
bus_.publish(Event::withText(EventType::Notification, "SD card over 80% full",
|
||||
static_cast<int32_t>(NotificationLevel::Warning)));
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,36 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
|
||||
#include "event_bus.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
struct StorageState {
|
||||
bool present = false;
|
||||
uint64_t totalBytes = 0;
|
||||
uint64_t usedBytes = 0;
|
||||
int usedPercent = 0;
|
||||
int level = 0; // 0, 80, 90 or 100 (full)
|
||||
bool logsAllowed = false;
|
||||
bool capturesAllowed = false;
|
||||
};
|
||||
|
||||
// Applies the SD card rules (see CONTEXT.md): Storage Warning once per boot past 80 %, Logs stop
|
||||
// past 90 % to keep room for Captures, Captures stop when the card is full.
|
||||
class StorageMonitor {
|
||||
public:
|
||||
static constexpr uint64_t kFullReserveBytes = 2ull * 1024 * 1024;
|
||||
|
||||
explicit StorageMonitor(EventBus& bus) : bus_(bus) {}
|
||||
|
||||
void update(bool present, uint64_t totalBytes, uint64_t usedBytes);
|
||||
const StorageState& state() const { return state_; }
|
||||
|
||||
private:
|
||||
EventBus& bus_;
|
||||
StorageState state_;
|
||||
bool warned_ = false;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,53 +0,0 @@
|
||||
#include "cleanup_plan.h"
|
||||
|
||||
#include <cstdio>
|
||||
|
||||
#include "storage_paths.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
int maxAgeDays(CleanupAge age) {
|
||||
switch (age) {
|
||||
case CleanupAge::OneMonth: return 30;
|
||||
case CleanupAge::ThreeMonths: return 91;
|
||||
case CleanupAge::SixMonths: return 182;
|
||||
case CleanupAge::OneYear: return 365;
|
||||
default: return -1;
|
||||
}
|
||||
}
|
||||
} // namespace
|
||||
|
||||
CleanupPlan CleanupPlan::make(const std::vector<StoredFile>& files, CleanupAge age, int todayDay) {
|
||||
CleanupPlan plan;
|
||||
for (auto& f : files) {
|
||||
if (f.path.rfind("/notes", 0) == 0) continue; // Notes are never cleaned up
|
||||
bool selected = age == CleanupAge::Everything;
|
||||
if (!selected) {
|
||||
size_t slash = f.path.find_last_of('/');
|
||||
int day = storage::fileDay(slash == std::string::npos ? f.path : f.path.substr(slash + 1));
|
||||
selected = day >= 0 && todayDay - day > maxAgeDays(age);
|
||||
}
|
||||
if (selected) {
|
||||
plan.paths.push_back(f.path);
|
||||
plan.bytes += f.bytes;
|
||||
}
|
||||
}
|
||||
return plan;
|
||||
}
|
||||
|
||||
std::string formatBytes(uint64_t bytes) {
|
||||
const char* units[] = {"B", "KB", "MB", "GB"};
|
||||
double v = static_cast<double>(bytes);
|
||||
int u = 0;
|
||||
while (v >= 1024 && u < 3) {
|
||||
v /= 1024;
|
||||
u++;
|
||||
}
|
||||
char buf[16];
|
||||
if (u == 0 || v >= 10) std::snprintf(buf, sizeof(buf), "%.0f %s", v, units[u]);
|
||||
else std::snprintf(buf, sizeof(buf), "%.1f %s", v, units[u]);
|
||||
return buf;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,41 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
namespace roro {
|
||||
|
||||
struct StoredFile {
|
||||
std::string path;
|
||||
uint64_t bytes;
|
||||
};
|
||||
|
||||
// What Storage Clean-up offers (see CONTEXT.md). Notes are deliberately absent.
|
||||
struct CleanupCategory {
|
||||
const char* label;
|
||||
const char* folder;
|
||||
};
|
||||
inline const CleanupCategory kCleanupCategories[] = {
|
||||
{"IRC logs", "/irc"},
|
||||
{"Wi-Fi scan logs", "/wifi/scans"},
|
||||
{"Wi-Fi captures", "/captures/wifi"},
|
||||
{"GNSS tracks", "/gnss/tracks"},
|
||||
};
|
||||
|
||||
enum class CleanupAge { OneMonth, ThreeMonths, SixMonths, OneYear, Everything };
|
||||
inline const char* const kCleanupAgeLabels[] = {"Older than 1 month", "Older than 3 months", "Older than 6 months",
|
||||
"Older than 1 year", "Everything"};
|
||||
|
||||
// The files a clean-up would delete, and how much space that frees. Dates come from file names;
|
||||
// undated files are only removed by Everything.
|
||||
struct CleanupPlan {
|
||||
std::vector<std::string> paths;
|
||||
uint64_t bytes = 0;
|
||||
|
||||
static CleanupPlan make(const std::vector<StoredFile>& files, CleanupAge age, int todayDay);
|
||||
};
|
||||
|
||||
std::string formatBytes(uint64_t bytes);
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,67 +0,0 @@
|
||||
#include "storage_paths.h"
|
||||
|
||||
#include <cctype>
|
||||
|
||||
namespace roro::storage {
|
||||
|
||||
namespace {
|
||||
|
||||
// Howard Hinnant's days_from_civil.
|
||||
int daysFromCivil(int y, int m, int d) {
|
||||
y -= m <= 2;
|
||||
int era = (y >= 0 ? y : y - 399) / 400;
|
||||
int yoe = y - era * 400;
|
||||
int doy = (153 * (m + (m > 2 ? -3 : 9)) + 2) / 5 + d - 1;
|
||||
int doe = yoe * 365 + yoe / 4 - yoe / 100 + doy;
|
||||
return era * 146097 + doe - 719468;
|
||||
}
|
||||
|
||||
bool digits(const std::string& s, size_t pos, size_t n, int& out) {
|
||||
if (pos + n > s.size()) return false;
|
||||
out = 0;
|
||||
for (size_t i = pos; i < pos + n; i++) {
|
||||
if (!std::isdigit(static_cast<unsigned char>(s[i]))) return false;
|
||||
out = out * 10 + (s[i] - '0');
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
int validDay(int y, int m, int d) {
|
||||
static const int kDays[] = {31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31};
|
||||
if (y < 1970 || m < 1 || m > 12 || d < 1 || d > kDays[m - 1]) return -1;
|
||||
return daysFromCivil(y, m, d);
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
std::string sanitize(const std::string& name) {
|
||||
std::string out;
|
||||
for (char c : name) {
|
||||
bool forbidden = c == '\\' || c == '/' || c == ':' || c == '*' || c == '?' || c == '"' || c == '<' ||
|
||||
c == '>' || c == '|' || static_cast<unsigned char>(c) < 0x20;
|
||||
out += forbidden ? '_' : c;
|
||||
}
|
||||
if (out.empty() || out == ".") return "_";
|
||||
if (out == "..") return "_.";
|
||||
return out;
|
||||
}
|
||||
|
||||
std::string dailyLogPath(std::initializer_list<std::string> folders, const std::string& date) {
|
||||
std::string path;
|
||||
for (auto& f : folders) path += "/" + sanitize(f);
|
||||
return path + "/" + (date.empty() ? "undated" : date) + ".log";
|
||||
}
|
||||
|
||||
int fileDay(const std::string& name) {
|
||||
int y, m, d;
|
||||
if (digits(name, 0, 4, y) && name.size() > 10 && name[4] == '-' && digits(name, 5, 2, m) && name[7] == '-' &&
|
||||
digits(name, 8, 2, d))
|
||||
return validDay(y, m, d);
|
||||
if (digits(name, 0, 4, y) && digits(name, 4, 2, m) && digits(name, 6, 2, d) && name.size() > 8 && name[8] == '-')
|
||||
return validDay(y, m, d);
|
||||
return -1;
|
||||
}
|
||||
|
||||
int dayFromUtc(int64_t utcSeconds) { return static_cast<int>(utcSeconds / 86400); }
|
||||
|
||||
} // namespace roro::storage
|
||||
@@ -1,22 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <initializer_list>
|
||||
#include <string>
|
||||
|
||||
namespace roro::storage {
|
||||
|
||||
// Makes one path component safe for FAT: forbidden characters become '_', never empty or a dot name.
|
||||
std::string sanitize(const std::string& name);
|
||||
|
||||
// "/irc/libera/#roro/2026-10-02.log" from {"irc", "libera", "#roro"} and a local date
|
||||
// ("YYYY-MM-DD"); an empty date (clock not set yet) gives "undated.log".
|
||||
std::string dailyLogPath(std::initializer_list<std::string> folders, const std::string& date);
|
||||
|
||||
// Day number (days since 1970-01-01) encoded in a Log ("2026-10-02.log") or Capture
|
||||
// ("20261002-144500.pcap") file name, or -1 if the name carries no valid date.
|
||||
int fileDay(const std::string& fileName);
|
||||
|
||||
int dayFromUtc(int64_t utcSeconds);
|
||||
|
||||
} // namespace roro::storage
|
||||
@@ -1,44 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "key_event.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// A modal choice between buttons. The first button should be the safe one (e.g. "Cancel"):
|
||||
// it's highlighted initially, and Back always cancels.
|
||||
class DialogModel {
|
||||
public:
|
||||
static constexpr int kPending = -1;
|
||||
static constexpr int kCancelled = -2;
|
||||
|
||||
explicit DialogModel(std::vector<std::string> buttons) : buttons_(std::move(buttons)) {}
|
||||
|
||||
// Consumes every key while open.
|
||||
bool onKey(const KeyEvent& e) {
|
||||
if (result_ != kPending) return true;
|
||||
int last = static_cast<int>(buttons_.size()) - 1;
|
||||
switch (e.key) {
|
||||
case Key::Left: if (selected_ > 0) selected_--; break;
|
||||
case Key::Right: if (selected_ < last) selected_++; break;
|
||||
case Key::Tab: selected_ = selected_ == last ? 0 : selected_ + 1; break;
|
||||
case Key::Select: result_ = selected_; break;
|
||||
case Key::Back: result_ = kCancelled; break;
|
||||
default: break;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
const std::vector<std::string>& buttons() const { return buttons_; }
|
||||
int selected() const { return selected_; }
|
||||
int result() const { return result_; }
|
||||
|
||||
private:
|
||||
std::vector<std::string> buttons_;
|
||||
int selected_ = 0;
|
||||
int result_ = kPending;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,50 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <deque>
|
||||
#include <string>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Lines already entered, browsed shell-style: up() goes back in time, down() forward, and past the
|
||||
// newest line the draft being typed comes back.
|
||||
class InputHistory {
|
||||
public:
|
||||
explicit InputHistory(size_t capacity) : capacity_(capacity) {}
|
||||
|
||||
void add(const std::string& line) {
|
||||
browsing_ = -1;
|
||||
if (line.empty() || (!lines_.empty() && lines_.back() == line)) return;
|
||||
lines_.push_back(line);
|
||||
if (lines_.size() > capacity_) lines_.pop_front();
|
||||
}
|
||||
|
||||
// `current` is what the editor holds now (kept as the draft when browsing starts).
|
||||
bool up(const std::string& current, std::string& out) {
|
||||
if (lines_.empty() || browsing_ == 0) return false;
|
||||
if (browsing_ < 0) {
|
||||
draft_ = current;
|
||||
browsing_ = static_cast<int>(lines_.size());
|
||||
}
|
||||
out = lines_[--browsing_];
|
||||
return true;
|
||||
}
|
||||
|
||||
bool down(std::string& out) {
|
||||
if (browsing_ < 0) return false;
|
||||
if (++browsing_ >= static_cast<int>(lines_.size())) {
|
||||
browsing_ = -1;
|
||||
out = draft_;
|
||||
} else {
|
||||
out = lines_[browsing_];
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
private:
|
||||
size_t capacity_;
|
||||
std::deque<std::string> lines_;
|
||||
int browsing_ = -1; // index being shown, -1 when editing the draft
|
||||
std::string draft_;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,30 +0,0 @@
|
||||
#include "line_editor.h"
|
||||
|
||||
#include "utf8.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
void LineEditor::setText(const std::string& text) {
|
||||
text_ = text.substr(0, utf8::clampToBoundary(text, max_));
|
||||
cursor_ = text_.size();
|
||||
}
|
||||
|
||||
bool LineEditor::insert(uint32_t codePoint) {
|
||||
std::string encoded = utf8::encode(codePoint);
|
||||
if (text_.size() + encoded.size() > max_) return false;
|
||||
text_.insert(cursor_, encoded);
|
||||
cursor_ += encoded.size();
|
||||
return true;
|
||||
}
|
||||
|
||||
void LineEditor::backspace() {
|
||||
if (cursor_ == 0) return;
|
||||
size_t start = utf8::previous(text_, cursor_);
|
||||
text_.erase(start, cursor_ - start);
|
||||
cursor_ = start;
|
||||
}
|
||||
|
||||
void LineEditor::left() { cursor_ = utf8::previous(text_, cursor_); }
|
||||
void LineEditor::right() { cursor_ = utf8::next(text_, cursor_); }
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,32 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Single-line UTF-8 text editing. The cursor is a byte index always on a character boundary,
|
||||
// and the text never exceeds maxBytes (protocol fields are limited in bytes, not characters).
|
||||
class LineEditor {
|
||||
public:
|
||||
explicit LineEditor(size_t maxBytes) : max_(maxBytes) {}
|
||||
|
||||
void setText(const std::string& text); // truncates, cursor to end
|
||||
const std::string& text() const { return text_; }
|
||||
size_t cursor() const { return cursor_; }
|
||||
size_t maxBytes() const { return max_; }
|
||||
|
||||
bool insert(uint32_t codePoint); // false if it would not fit
|
||||
void backspace();
|
||||
void left();
|
||||
void right();
|
||||
void home() { cursor_ = 0; }
|
||||
void end() { cursor_ = text_.size(); }
|
||||
|
||||
private:
|
||||
size_t max_;
|
||||
std::string text_;
|
||||
size_t cursor_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,41 +0,0 @@
|
||||
#include "list_model.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
void ListModel::setCount(int count) {
|
||||
count_ = count < 0 ? 0 : count;
|
||||
if (count_ == 0) {
|
||||
selected_ = -1;
|
||||
first_ = 0;
|
||||
return;
|
||||
}
|
||||
select(selected_ < 0 ? 0 : selected_);
|
||||
}
|
||||
|
||||
void ListModel::select(int index) {
|
||||
if (count_ == 0) return;
|
||||
selected_ = index < 0 ? 0 : index >= count_ ? count_ - 1 : index;
|
||||
scrollToSelection();
|
||||
}
|
||||
|
||||
void ListModel::up() {
|
||||
if (count_ == 0) return;
|
||||
select(selected_ == 0 ? count_ - 1 : selected_ - 1);
|
||||
}
|
||||
|
||||
void ListModel::down() {
|
||||
if (count_ == 0) return;
|
||||
select(selected_ == count_ - 1 ? 0 : selected_ + 1);
|
||||
}
|
||||
|
||||
void ListModel::pageUp() { select(selected_ - rows_); }
|
||||
void ListModel::pageDown() { select(selected_ + rows_); }
|
||||
|
||||
void ListModel::scrollToSelection() {
|
||||
if (selected_ < first_) first_ = selected_;
|
||||
if (selected_ >= first_ + rows_) first_ = selected_ - rows_ + 1;
|
||||
int maxFirst = count_ > rows_ ? count_ - rows_ : 0;
|
||||
if (first_ > maxFirst) first_ = maxFirst;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,32 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Selection and scrolling for a vertical list showing `visibleRows` rows at a time.
|
||||
// Up/Down wrap around; page moves don't.
|
||||
class ListModel {
|
||||
public:
|
||||
explicit ListModel(int visibleRows) : rows_(visibleRows) {}
|
||||
|
||||
void setCount(int count);
|
||||
int count() const { return count_; }
|
||||
int selected() const { return selected_; } // -1 when empty
|
||||
int firstVisible() const { return first_; }
|
||||
int visibleRows() const { return rows_; }
|
||||
|
||||
void select(int index);
|
||||
void up();
|
||||
void down();
|
||||
void pageUp();
|
||||
void pageDown();
|
||||
|
||||
private:
|
||||
void scrollToSelection();
|
||||
|
||||
int rows_;
|
||||
int count_ = 0;
|
||||
int selected_ = -1;
|
||||
int first_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,60 +0,0 @@
|
||||
#include "text_wrap.h"
|
||||
|
||||
#include "utf8.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
|
||||
void wrapParagraph(const std::string& para, int maxWidth, const MeasureText& measure,
|
||||
std::vector<std::string>& out) {
|
||||
std::string line;
|
||||
size_t pos = 0;
|
||||
while (pos < para.size()) {
|
||||
size_t space = para.find(' ', pos);
|
||||
std::string word = para.substr(pos, space == std::string::npos ? std::string::npos : space - pos);
|
||||
pos = space == std::string::npos ? para.size() : space + 1;
|
||||
|
||||
std::string candidate = line.empty() ? word : line + " " + word;
|
||||
if (measure(candidate) <= maxWidth) {
|
||||
line = candidate;
|
||||
continue;
|
||||
}
|
||||
if (!line.empty()) {
|
||||
out.push_back(line);
|
||||
line.clear();
|
||||
}
|
||||
// The word alone may still be too wide: cut it character by character.
|
||||
while (measure(word) > maxWidth) {
|
||||
size_t cut = 0;
|
||||
while (true) {
|
||||
size_t nextCut = utf8::next(word, cut);
|
||||
if (measure(word.substr(0, nextCut)) > maxWidth) break;
|
||||
cut = nextCut;
|
||||
}
|
||||
if (cut == 0) cut = utf8::next(word, 0); // a single character wider than the line
|
||||
out.push_back(word.substr(0, cut));
|
||||
word = word.substr(cut);
|
||||
}
|
||||
line = word;
|
||||
}
|
||||
out.push_back(line);
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
std::vector<std::string> wrapText(const std::string& text, int maxWidth, const MeasureText& measure) {
|
||||
std::vector<std::string> lines;
|
||||
if (text.empty()) return lines;
|
||||
size_t start = 0;
|
||||
while (true) {
|
||||
size_t nl = text.find('\n', start);
|
||||
wrapParagraph(text.substr(start, nl == std::string::npos ? std::string::npos : nl - start), maxWidth,
|
||||
measure, lines);
|
||||
if (nl == std::string::npos) break;
|
||||
start = nl + 1;
|
||||
}
|
||||
return lines;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,15 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <functional>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
namespace roro {
|
||||
|
||||
using MeasureText = std::function<int(const std::string&)>;
|
||||
|
||||
// Splits UTF-8 text into lines no wider than maxWidth: breaks at spaces when possible, inside
|
||||
// words only when a word alone is too wide, never inside a character. '\n' forces a break.
|
||||
std::vector<std::string> wrapText(const std::string& text, int maxWidth, const MeasureText& measure);
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,42 +0,0 @@
|
||||
#include "toast_queue.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
void ToastQueue::push(const std::string& text, NotificationLevel level, uint32_t nowMs) {
|
||||
current(nowMs); // retire an expired Toast first, so the new one gets its full time
|
||||
if (queue_.size() == capacity_) {
|
||||
// Keep the visible one; drop the oldest waiting.
|
||||
queue_.erase(queue_.begin() + (showing_ && queue_.size() > 1 ? 1 : 0));
|
||||
if (!showing_) changed_ = true;
|
||||
}
|
||||
queue_.push_back({text, level, nextId_++});
|
||||
if (!showing_) {
|
||||
showing_ = true;
|
||||
shownAtMs_ = nowMs;
|
||||
changed_ = true;
|
||||
}
|
||||
}
|
||||
|
||||
const Toast* ToastQueue::current(uint32_t nowMs) {
|
||||
if (!showing_) return nullptr;
|
||||
// Signed: a caller's clock reading may be a few ms older than the Toast's stamp.
|
||||
int32_t elapsed = static_cast<int32_t>(nowMs - shownAtMs_);
|
||||
if (elapsed >= static_cast<int32_t>(durationMs_)) dismiss(shownAtMs_ + durationMs_);
|
||||
return showing_ ? &queue_.front() : nullptr;
|
||||
}
|
||||
|
||||
void ToastQueue::dismiss(uint32_t nowMs) {
|
||||
if (!showing_) return;
|
||||
queue_.pop_front();
|
||||
changed_ = true;
|
||||
showing_ = !queue_.empty();
|
||||
shownAtMs_ = nowMs;
|
||||
}
|
||||
|
||||
bool ToastQueue::takeChanged() {
|
||||
bool c = changed_;
|
||||
changed_ = false;
|
||||
return c;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,41 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <deque>
|
||||
#include <string>
|
||||
|
||||
#include "event.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
struct Toast {
|
||||
std::string text;
|
||||
NotificationLevel level;
|
||||
uint32_t id; // unique per push, to tell two identical Toasts apart
|
||||
};
|
||||
|
||||
// Notifications waiting to be shown as Toasts, one at a time, each for the same duration.
|
||||
class ToastQueue {
|
||||
public:
|
||||
explicit ToastQueue(uint32_t durationMs, size_t capacity = 4) : durationMs_(durationMs), capacity_(capacity) {}
|
||||
|
||||
void push(const std::string& text, NotificationLevel level, uint32_t nowMs);
|
||||
|
||||
// The Toast to show now, or nullptr. Advances the queue as Toasts expire.
|
||||
const Toast* current(uint32_t nowMs);
|
||||
void dismiss(uint32_t nowMs);
|
||||
|
||||
// True once after the visible Toast changed (appeared, switched or disappeared).
|
||||
bool takeChanged();
|
||||
|
||||
private:
|
||||
uint32_t durationMs_;
|
||||
size_t capacity_;
|
||||
std::deque<Toast> queue_;
|
||||
bool showing_ = false;
|
||||
uint32_t shownAtMs_ = 0;
|
||||
bool changed_ = false;
|
||||
uint32_t nextId_ = 1;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,53 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
|
||||
namespace roro::utf8 {
|
||||
|
||||
inline bool isContinuation(unsigned char c) { return (c & 0xC0) == 0x80; }
|
||||
|
||||
inline std::string encode(uint32_t cp) {
|
||||
std::string out;
|
||||
if (cp < 0x80) {
|
||||
out += static_cast<char>(cp);
|
||||
} else if (cp < 0x800) {
|
||||
out += static_cast<char>(0xC0 | (cp >> 6));
|
||||
out += static_cast<char>(0x80 | (cp & 0x3F));
|
||||
} else if (cp < 0x10000) {
|
||||
out += static_cast<char>(0xE0 | (cp >> 12));
|
||||
out += static_cast<char>(0x80 | ((cp >> 6) & 0x3F));
|
||||
out += static_cast<char>(0x80 | (cp & 0x3F));
|
||||
} else {
|
||||
out += static_cast<char>(0xF0 | (cp >> 18));
|
||||
out += static_cast<char>(0x80 | ((cp >> 12) & 0x3F));
|
||||
out += static_cast<char>(0x80 | ((cp >> 6) & 0x3F));
|
||||
out += static_cast<char>(0x80 | (cp & 0x3F));
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
// Byte index of the character start before / after `pos`.
|
||||
inline size_t previous(const std::string& s, size_t pos) {
|
||||
if (pos == 0) return 0;
|
||||
do pos--;
|
||||
while (pos > 0 && isContinuation(static_cast<unsigned char>(s[pos])));
|
||||
return pos;
|
||||
}
|
||||
|
||||
inline size_t next(const std::string& s, size_t pos) {
|
||||
if (pos >= s.size()) return s.size();
|
||||
do pos++;
|
||||
while (pos < s.size() && isContinuation(static_cast<unsigned char>(s[pos])));
|
||||
return pos;
|
||||
}
|
||||
|
||||
// Longest prefix of at most `maxBytes` that doesn't cut a character.
|
||||
inline size_t clampToBoundary(const std::string& s, size_t maxBytes) {
|
||||
if (s.size() <= maxBytes) return s.size();
|
||||
size_t pos = maxBytes;
|
||||
while (pos > 0 && isContinuation(static_cast<unsigned char>(s[pos]))) pos--;
|
||||
return pos;
|
||||
}
|
||||
|
||||
} // namespace roro::utf8
|
||||
@@ -1,14 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#ifndef RORO_VERSION
|
||||
#define RORO_VERSION "unknown"
|
||||
#endif
|
||||
|
||||
namespace roro {
|
||||
|
||||
constexpr const char* kProductName = "roro9stack";
|
||||
|
||||
// "roro9stack v0.1.0" — used on the boot screen and in About.
|
||||
inline const char* versionString() { return RORO_VERSION; }
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,35 +0,0 @@
|
||||
#include "channel_occupancy.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
// -90 dBm (barely there) -> 0.1, -40 dBm and stronger -> 1.
|
||||
float weight(int rssi) {
|
||||
float w = (rssi + 90) / 50.0f;
|
||||
if (w < 0.1f) w = 0.1f;
|
||||
if (w > 1.0f) w = 1.0f;
|
||||
return w;
|
||||
}
|
||||
const float kSpill[] = {1.0f, 0.5f, 0.2f}; // same channel, one away, two away
|
||||
} // namespace
|
||||
|
||||
std::array<float, 14> channelLoad(const std::vector<ChannelSighting>& sightings) {
|
||||
std::array<float, 14> load{};
|
||||
for (auto& s : sightings) {
|
||||
if (s.channel < 1 || s.channel > 13) continue;
|
||||
for (int d = -2; d <= 2; d++) {
|
||||
int ch = s.channel + d;
|
||||
if (ch >= 1 && ch <= 13) load[ch] += weight(s.rssi) * kSpill[d < 0 ? -d : d];
|
||||
}
|
||||
}
|
||||
return load;
|
||||
}
|
||||
|
||||
int quietestChannel(const std::array<float, 14>& load) {
|
||||
int best = 1;
|
||||
for (int ch : {6, 11})
|
||||
if (load[ch] < load[best]) best = ch;
|
||||
return best;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,21 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <array>
|
||||
#include <vector>
|
||||
|
||||
namespace roro {
|
||||
|
||||
struct ChannelSighting {
|
||||
int channel;
|
||||
int rssi;
|
||||
};
|
||||
|
||||
// How crowded each 2.4 GHz Wi-Fi channel (1..13) is, from the access points a scan saw. A 20 MHz
|
||||
// network spills onto the channels up to two away, less the further it is; a strong signal
|
||||
// counts more than a faint one. Index 0 is unused.
|
||||
std::array<float, 14> channelLoad(const std::vector<ChannelSighting>& sightings);
|
||||
|
||||
// The least crowded of the non-overlapping channels 1, 6 and 11 (the lowest on a tie).
|
||||
int quietestChannel(const std::array<float, 14>& load);
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,59 +0,0 @@
|
||||
#include "network_list_view.h"
|
||||
|
||||
#include <algorithm>
|
||||
#include <cctype>
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
std::string lower(std::string s) {
|
||||
for (auto& c : s) c = static_cast<char>(std::tolower(static_cast<unsigned char>(c)));
|
||||
return s;
|
||||
}
|
||||
} // namespace
|
||||
|
||||
std::vector<int> orderNetworks(const std::vector<ScanEntry>& entries, WifiSort sort, const NetworkFilter& filter) {
|
||||
std::vector<int> idx;
|
||||
for (int i = 0; i < static_cast<int>(entries.size()); i++) {
|
||||
const ScanEntry& e = entries[i];
|
||||
if (filter.openOnly && !e.open) continue;
|
||||
if (filter.hideHidden && e.ssid.empty()) continue;
|
||||
if (e.rssi < filter.minRssi) continue;
|
||||
idx.push_back(i);
|
||||
}
|
||||
std::stable_sort(idx.begin(), idx.end(), [&](int a, int b) {
|
||||
const ScanEntry& x = entries[a];
|
||||
const ScanEntry& y = entries[b];
|
||||
switch (sort) {
|
||||
case WifiSort::Signal: return x.rssi > y.rssi; // strongest first
|
||||
case WifiSort::Channel: return x.channel != y.channel ? x.channel < y.channel : x.rssi > y.rssi;
|
||||
case WifiSort::Name: {
|
||||
// Hidden networks (no name) sort to the end.
|
||||
if (x.ssid.empty() != y.ssid.empty()) return y.ssid.empty();
|
||||
return lower(x.ssid) < lower(y.ssid);
|
||||
}
|
||||
}
|
||||
return false;
|
||||
});
|
||||
return idx;
|
||||
}
|
||||
|
||||
const char* sortName(WifiSort sort) {
|
||||
switch (sort) {
|
||||
case WifiSort::Signal: return "signal";
|
||||
case WifiSort::Channel: return "channel";
|
||||
case WifiSort::Name: return "name";
|
||||
}
|
||||
return "";
|
||||
}
|
||||
|
||||
WifiSort nextSort(WifiSort sort) {
|
||||
switch (sort) {
|
||||
case WifiSort::Signal: return WifiSort::Channel;
|
||||
case WifiSort::Channel: return WifiSort::Name;
|
||||
case WifiSort::Name: return WifiSort::Signal;
|
||||
}
|
||||
return WifiSort::Signal;
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,25 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "scan_entry.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
enum class WifiSort { Signal, Channel, Name };
|
||||
|
||||
struct NetworkFilter {
|
||||
bool openOnly = false;
|
||||
bool hideHidden = false;
|
||||
int minRssi = -100; // drop anything weaker
|
||||
};
|
||||
|
||||
// The order and selection the network list shows: indices into `entries`, sorted and filtered.
|
||||
// Stable, so equal rows keep their scan order.
|
||||
std::vector<int> orderNetworks(const std::vector<ScanEntry>& entries, WifiSort sort, const NetworkFilter& filter);
|
||||
|
||||
const char* sortName(WifiSort sort);
|
||||
WifiSort nextSort(WifiSort sort);
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,67 +0,0 @@
|
||||
#include "saved_networks.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
std::string key(int i, const char* field) { return "net" + std::to_string(i) + "_" + field; }
|
||||
} // namespace
|
||||
|
||||
void SavedNetworks::load() {
|
||||
networks_.clear();
|
||||
int32_t n = 0;
|
||||
store_.getInt("net_count", n);
|
||||
for (int i = 0; i < n && i < kMax; i++) {
|
||||
SavedNetwork net;
|
||||
if (!store_.getString(key(i, "ssid").c_str(), net.ssid)) break;
|
||||
store_.getString(key(i, "pass").c_str(), net.password);
|
||||
int32_t hidden = 0;
|
||||
store_.getInt(key(i, "hid").c_str(), hidden);
|
||||
net.hidden = hidden != 0;
|
||||
networks_.push_back(net);
|
||||
}
|
||||
}
|
||||
|
||||
const SavedNetwork* SavedNetworks::find(const std::string& ssid) const {
|
||||
for (auto& n : networks_)
|
||||
if (n.ssid == ssid) return &n;
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
std::string SavedNetworks::add(const std::string& ssid, const std::string& password, bool hidden) {
|
||||
if (ssid.empty() || ssid.size() > 32) return "Network name must be 1 to 32 bytes";
|
||||
if (!password.empty() && (password.size() < 8 || password.size() > 63))
|
||||
return "Password must be 8 to 63 characters (or empty for an open network)";
|
||||
for (auto& n : networks_) {
|
||||
if (n.ssid == ssid) {
|
||||
n.password = password;
|
||||
n.hidden = hidden;
|
||||
save();
|
||||
return "";
|
||||
}
|
||||
}
|
||||
if (count() >= kMax) return "Already 8 saved networks: forget one first";
|
||||
networks_.push_back({ssid, password, hidden});
|
||||
save();
|
||||
return "";
|
||||
}
|
||||
|
||||
void SavedNetworks::forget(const std::string& ssid) {
|
||||
for (auto it = networks_.begin(); it != networks_.end(); ++it) {
|
||||
if (it->ssid == ssid) {
|
||||
networks_.erase(it);
|
||||
save();
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void SavedNetworks::save() {
|
||||
for (int i = 0; i < count(); i++) {
|
||||
store_.putString(key(i, "ssid").c_str(), networks_[i].ssid);
|
||||
store_.putString(key(i, "pass").c_str(), networks_[i].password);
|
||||
store_.putInt(key(i, "hid").c_str(), networks_[i].hidden ? 1 : 0);
|
||||
}
|
||||
store_.putInt("net_count", count());
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,39 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "key_value_store.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
struct SavedNetwork {
|
||||
std::string ssid;
|
||||
std::string password; // empty for an open network
|
||||
bool hidden = false; // doesn't broadcast its name, so never shows up in scans
|
||||
};
|
||||
|
||||
// The Saved Networks the Wi-Fi Service may join (see CONTEXT.md), persisted in internal flash.
|
||||
class SavedNetworks {
|
||||
public:
|
||||
static constexpr int kMax = 8;
|
||||
|
||||
explicit SavedNetworks(KeyValueStore& store) : store_(store) {}
|
||||
|
||||
void load();
|
||||
int count() const { return static_cast<int>(networks_.size()); }
|
||||
const SavedNetwork& at(int i) const { return networks_[i]; }
|
||||
const SavedNetwork* find(const std::string& ssid) const;
|
||||
|
||||
// Adds, or updates the password of an existing SSID. Empty on success, otherwise why not.
|
||||
std::string add(const std::string& ssid, const std::string& password, bool hidden = false);
|
||||
void forget(const std::string& ssid);
|
||||
|
||||
private:
|
||||
void save();
|
||||
|
||||
KeyValueStore& store_;
|
||||
std::vector<SavedNetwork> networks_;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,18 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// One access point an ordinary Wi-Fi scan reported (a network announcing itself). No client or
|
||||
// monitor-mode data: just what a beacon broadcasts.
|
||||
struct ScanEntry {
|
||||
std::string ssid; // empty for a hidden network
|
||||
std::string bssid; // the access point's own address, from its beacon
|
||||
int channel;
|
||||
int rssi;
|
||||
bool open;
|
||||
std::string security; // "open", "WPA2", "WPA3"...
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,27 +0,0 @@
|
||||
#include "scan_log.h"
|
||||
|
||||
namespace roro::scanlog {
|
||||
|
||||
std::string csvField(const std::string& value) {
|
||||
bool needsQuote = false;
|
||||
for (char c : value)
|
||||
if (c == ',' || c == '"' || c == '\n' || c == '\r') needsQuote = true;
|
||||
if (!needsQuote) return value;
|
||||
std::string out = "\"";
|
||||
for (char c : value) {
|
||||
if (c == '"') out += '"'; // escape by doubling
|
||||
out += c;
|
||||
}
|
||||
out += '"';
|
||||
return out;
|
||||
}
|
||||
|
||||
std::string header() { return "time,bssid,channel,rssi,security,ssid"; }
|
||||
|
||||
std::string row(const std::string& timestamp, const ScanEntry& ap) {
|
||||
return csvField(timestamp) + "," + csvField(ap.bssid) + "," + std::to_string(ap.channel) + "," +
|
||||
std::to_string(ap.rssi) + "," + csvField(ap.security) + "," +
|
||||
csvField(ap.ssid.empty() ? "(hidden)" : ap.ssid);
|
||||
}
|
||||
|
||||
} // namespace roro::scanlog
|
||||
@@ -1,43 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "scan_entry.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Writes what Wi-Fi Tools already sees (access points, channel, signal) to a CSV Log, so the user
|
||||
// can track their own Wi-Fi environment over time. One row per access point per logged scan.
|
||||
namespace scanlog {
|
||||
|
||||
// A CSV field, quoted when it contains a comma, quote or newline.
|
||||
std::string csvField(const std::string& value);
|
||||
|
||||
// The header row (no trailing newline).
|
||||
std::string header();
|
||||
|
||||
// One data row for an access point seen at `timestamp` (a preformatted local time string).
|
||||
std::string row(const std::string& timestamp, const ScanEntry& ap);
|
||||
|
||||
} // namespace scanlog
|
||||
|
||||
// Decides when to write a scan to the Log: at most once per interval.
|
||||
class ScanLogThrottle {
|
||||
public:
|
||||
explicit ScanLogThrottle(uint32_t intervalMs) : intervalMs_(intervalMs) {}
|
||||
bool due(uint32_t nowMs) const { return !logged_ || nowMs - lastMs_ >= intervalMs_; }
|
||||
void logged(uint32_t nowMs) {
|
||||
lastMs_ = nowMs;
|
||||
logged_ = true;
|
||||
}
|
||||
void reset() { logged_ = false; }
|
||||
|
||||
private:
|
||||
uint32_t intervalMs_;
|
||||
uint32_t lastMs_ = 0;
|
||||
bool logged_ = false;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,52 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
#include <deque>
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Follows one access point's signal over repeated scans, for finding where it is.
|
||||
class SignalTracker {
|
||||
public:
|
||||
static constexpr int kNoSignal = -127;
|
||||
static constexpr uint32_t kLostAfterMs = 5000;
|
||||
static constexpr uint32_t kFastestClickMs = 60;
|
||||
static constexpr uint32_t kSlowestClickMs = 1200;
|
||||
|
||||
explicit SignalTracker(size_t historySize) : size_(historySize) {}
|
||||
|
||||
void seen(int rssi, uint32_t nowMs) {
|
||||
push(rssi);
|
||||
latest_ = rssi;
|
||||
lastSeenMs_ = nowMs;
|
||||
everSeen_ = true;
|
||||
}
|
||||
void missed() { push(kNoSignal); } // a scan that didn't see it
|
||||
|
||||
bool lost(uint32_t nowMs) const { return !everSeen_ || nowMs - lastSeenMs_ >= kLostAfterMs; }
|
||||
int latest() const { return latest_; }
|
||||
const std::deque<int>& history() const { return history_; }
|
||||
|
||||
// Time between clicks: fast when the signal is strong (close), slow when faint.
|
||||
static uint32_t clickIntervalMs(int rssi) {
|
||||
if (rssi >= -35) return kFastestClickMs;
|
||||
if (rssi <= -95) return kSlowestClickMs;
|
||||
float t = (rssi + 95) / 60.0f; // 0 at -95 dBm, 1 at -35 dBm
|
||||
return static_cast<uint32_t>(kSlowestClickMs - t * (kSlowestClickMs - kFastestClickMs));
|
||||
}
|
||||
|
||||
private:
|
||||
void push(int v) {
|
||||
history_.push_back(v);
|
||||
if (history_.size() > size_) history_.pop_front();
|
||||
}
|
||||
|
||||
size_t size_;
|
||||
std::deque<int> history_;
|
||||
int latest_ = kNoSignal;
|
||||
uint32_t lastSeenMs_ = 0;
|
||||
bool everSeen_ = false;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,99 +0,0 @@
|
||||
#include "wifi_controller.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
const uint32_t kRetryDelaysMs[] = {10000, 30000, 60000};
|
||||
const int kRetrySteps = sizeof(kRetryDelaysMs) / sizeof(kRetryDelaysMs[0]);
|
||||
} // namespace
|
||||
|
||||
WifiController::Step WifiController::wait(uint32_t nowMs) {
|
||||
state_ = State::Waiting;
|
||||
retryAtMs_ = nowMs + kRetryDelaysMs[retries_ < kRetrySteps ? retries_ : kRetrySteps - 1];
|
||||
retries_++;
|
||||
return act(Action::None);
|
||||
}
|
||||
|
||||
WifiController::Step WifiController::update(uint32_t nowMs, bool enabled) {
|
||||
if (state_ == State::Monitoring) return act(Action::None);
|
||||
if (!enabled || saved_.count() == 0) { // nothing to join: keep the radio off
|
||||
if (state_ == State::Off) return act(Action::None);
|
||||
state_ = State::Off;
|
||||
ssid_.clear();
|
||||
return act(Action::RadioOff);
|
||||
}
|
||||
switch (state_) {
|
||||
case State::Off:
|
||||
state_ = State::Scanning;
|
||||
return act(Action::StartScan);
|
||||
case State::Waiting:
|
||||
if (static_cast<int32_t>(nowMs - retryAtMs_) < 0) return act(Action::None);
|
||||
state_ = State::Scanning;
|
||||
return act(Action::StartScan);
|
||||
case State::Connecting:
|
||||
if (nowMs - sinceMs_ < kConnectTimeoutMs) return act(Action::None);
|
||||
wait(nowMs);
|
||||
return act(Action::Disconnect);
|
||||
default:
|
||||
return act(Action::None);
|
||||
}
|
||||
}
|
||||
|
||||
WifiController::Step WifiController::scanDone(const std::vector<ScanResult>& results, uint32_t nowMs) {
|
||||
if (state_ != State::Scanning) return act(Action::None);
|
||||
const ScanResult* best = nullptr;
|
||||
for (auto& r : results)
|
||||
if (saved_.find(r.ssid) && (!best || r.rssi > best->rssi)) best = &r;
|
||||
const SavedNetwork* net = best ? saved_.find(best->ssid) : nullptr;
|
||||
if (!net) {
|
||||
// Hidden networks never appear in scans: try them one at a time.
|
||||
for (int i = 0; i < saved_.count() && !net; i++) {
|
||||
const SavedNetwork& candidate = saved_.at((nextHidden_ + i) % saved_.count());
|
||||
if (candidate.hidden) {
|
||||
net = &candidate;
|
||||
nextHidden_ = (nextHidden_ + i + 1) % saved_.count();
|
||||
}
|
||||
}
|
||||
}
|
||||
if (!net) return wait(nowMs);
|
||||
|
||||
state_ = State::Connecting;
|
||||
ssid_ = net->ssid;
|
||||
sinceMs_ = nowMs;
|
||||
return Step{Action::Connect, net->ssid, net->password};
|
||||
}
|
||||
|
||||
WifiController::Step WifiController::connected(uint32_t) {
|
||||
if (state_ != State::Connecting) return act(Action::None);
|
||||
state_ = State::Connected;
|
||||
retries_ = 0;
|
||||
return act(Action::None);
|
||||
}
|
||||
|
||||
WifiController::Step WifiController::disconnected(uint32_t nowMs) {
|
||||
if (state_ == State::Connected) {
|
||||
state_ = State::Scanning;
|
||||
return act(Action::StartScan);
|
||||
}
|
||||
if (state_ == State::Connecting) return wait(nowMs); // e.g. wrong password
|
||||
return act(Action::None);
|
||||
}
|
||||
|
||||
WifiController::Step WifiController::requestMonitor() {
|
||||
state_ = State::Monitoring;
|
||||
ssid_.clear();
|
||||
return act(Action::StartMonitor);
|
||||
}
|
||||
|
||||
WifiController::Step WifiController::releaseMonitor(bool enabled) {
|
||||
if (state_ != State::Monitoring) return act(Action::None);
|
||||
retries_ = 0;
|
||||
if (enabled) {
|
||||
state_ = State::Scanning;
|
||||
return act(Action::StopMonitorAndScan);
|
||||
}
|
||||
state_ = State::Off;
|
||||
return act(Action::StopMonitorAndOff);
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,64 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "saved_networks.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
struct ScanResult {
|
||||
std::string ssid;
|
||||
int rssi;
|
||||
};
|
||||
|
||||
// Decides what the Wi-Fi radio should do next. The Wi-Fi Service feeds it what happened (scan
|
||||
// results, connected, disconnected, Monitoring requests) and carries out the returned Action.
|
||||
// Stays Connected to the strongest Saved Network in range while enabled (radio off when there are
|
||||
// no Saved Networks); Monitoring overrides.
|
||||
class WifiController {
|
||||
public:
|
||||
enum class State { Off, Scanning, Connecting, Connected, Waiting, Monitoring };
|
||||
enum class Action { None, StartScan, Connect, Disconnect, RadioOff, StartMonitor, StopMonitorAndScan, StopMonitorAndOff };
|
||||
|
||||
struct Step {
|
||||
Action action = Action::None;
|
||||
std::string ssid;
|
||||
std::string password;
|
||||
};
|
||||
|
||||
static constexpr uint32_t kConnectTimeoutMs = 15000;
|
||||
|
||||
explicit WifiController(const SavedNetworks& saved) : saved_(saved) {}
|
||||
|
||||
Step update(uint32_t nowMs, bool enabled);
|
||||
Step scanDone(const std::vector<ScanResult>& results, uint32_t nowMs);
|
||||
Step connected(uint32_t nowMs);
|
||||
Step disconnected(uint32_t nowMs);
|
||||
// A Saved Network was just added: stop waiting and scan now.
|
||||
void retryNow(uint32_t nowMs) {
|
||||
if (state_ == State::Waiting) retryAtMs_ = nowMs;
|
||||
retries_ = 0;
|
||||
}
|
||||
|
||||
Step requestMonitor();
|
||||
Step releaseMonitor(bool enabled);
|
||||
|
||||
State state() const { return state_; }
|
||||
const std::string& ssid() const { return ssid_; } // network joined or being joined
|
||||
|
||||
private:
|
||||
Step wait(uint32_t nowMs);
|
||||
static Step act(Action a) { return Step{a, "", ""}; }
|
||||
|
||||
const SavedNetworks& saved_;
|
||||
State state_ = State::Off;
|
||||
std::string ssid_;
|
||||
uint32_t sinceMs_ = 0; // when Connecting started
|
||||
uint32_t retryAtMs_ = 0; // when Waiting ends
|
||||
int retries_ = 0;
|
||||
int nextHidden_ = 0; // round-robin over hidden Saved Networks
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -1,47 +0,0 @@
|
||||
; roro9stack — firmware for M5Stack Cardputer ADV + Cap LoRa-1262
|
||||
; Build/test/flash through scripts/ci.sh and scripts/flash.sh (Docker), see README.
|
||||
|
||||
[platformio]
|
||||
default_envs = cardputer-adv
|
||||
|
||||
[env]
|
||||
extra_scripts = pre:scripts/version.py
|
||||
test_framework = unity
|
||||
|
||||
[env:cardputer-adv]
|
||||
platform = https://github.com/pioarduino/platform-espressif32/releases/download/55.03.312/platform-espressif32.zip
|
||||
board = m5stack-stamps3
|
||||
framework = arduino
|
||||
board_build.partitions = default_8MB.csv
|
||||
monitor_speed = 115200
|
||||
build_flags =
|
||||
-DARDUINO_USB_CDC_ON_BOOT=1
|
||||
-DARDUINO_USB_MODE=1
|
||||
lib_deps =
|
||||
m5stack/M5Cardputer @ 1.1.1
|
||||
test_ignore = *
|
||||
; Smaller TLS buffers (M2): the framework is rebuilt with these settings (pioarduino "hybrid
|
||||
; compile"). Receive stays 16 KB (servers send full TLS records); send drops to 4 KB (IRC lines are
|
||||
; short); buffers are allocated as needed and handshake-only data is freed once connected.
|
||||
custom_sdkconfig =
|
||||
CONFIG_MBEDTLS_ASYMMETRIC_CONTENT_LEN=y
|
||||
CONFIG_MBEDTLS_SSL_IN_CONTENT_LEN=16384
|
||||
CONFIG_MBEDTLS_SSL_OUT_CONTENT_LEN=4096
|
||||
CONFIG_MBEDTLS_DYNAMIC_BUFFER=y
|
||||
CONFIG_MBEDTLS_DYNAMIC_FREE_CONFIG_DATA=y
|
||||
CONFIG_MBEDTLS_DYNAMIC_FREE_CA_CERT=y
|
||||
|
||||
; Debug Build: the same firmware plus the Debug Console on TCP 2323 (see ADR 0004). The token comes
|
||||
; from ~/.config/roro9stack/debug-token, passed in by scripts/_docker.sh; it's never committed.
|
||||
[env:cardputer-adv-debug]
|
||||
extends = env:cardputer-adv
|
||||
extra_scripts = pre:scripts/version.py, pre:scripts/debug_flags.py
|
||||
build_flags =
|
||||
${env:cardputer-adv.build_flags}
|
||||
-DRORO_DEBUG
|
||||
|
||||
; Host-side unit tests for pure logic (no hardware).
|
||||
[env:native]
|
||||
platform = native
|
||||
lib_ldf_mode = deep+
|
||||
build_flags = -std=gnu++17
|
||||
@@ -0,0 +1,7 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="115" height="20" role="img" aria-label="release: v0.12.0">
|
||||
<title>release: v0.12.0</title>
|
||||
<linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient>
|
||||
<clipPath id="r"><rect width="115" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)"><rect width="54" height="20" fill="#555"/><rect x="54" width="61" height="20" fill="#007ec6"/><rect width="115" height="20" fill="url(#s)"/></g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="27.0" y="14">release</text><text x="84.5" y="14">v0.12.0</text></g></svg>
|
||||
|
After Width: | Height: | Size: 720 B |
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user