├── .github └── workflows │ ├── Test.yml │ ├── docker.yml │ └── pages.yml ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── bin ├── docker-start.sh └── test.ps1 ├── env.test ├── requirements.txt ├── src ├── api │ ├── __init__.py │ ├── cannedMessageModule.py │ ├── localConfig.py │ ├── mattermost.py │ ├── messages.py │ ├── nodeInfo.py │ ├── positions.py │ └── serialPort.py ├── app.py ├── db.py └── entrypoint.sh └── tests ├── conftest.py ├── test_config.py ├── test_db.py ├── test_mattermost.py ├── test_nodes.py ├── test_positions.py ├── test_serial.py └── test_text.py /.github/workflows/Test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | test: 7 | runs-on: ubuntu-latest 8 | env: 9 | MATTERMOST_ENABLED: TRUE 10 | MATTERMOST_TOKEN: XYZ 11 | MATTERMOST_WEBHOOK: http://test.com/api/x 12 | steps: 13 | - uses: actions/checkout@v3 14 | - uses: actions/setup-python@v4 15 | with: 16 | python-version: '3.10' 17 | - run: pip install -r requirements.txt 18 | - run: pytest --cov=src --cov-report term-missing --cov-report lcov:coverage/lcov.info 19 | - name: Coveralls 20 | uses: coverallsapp/github-action@master 21 | with: 22 | github-token: ${{ secrets.GITHUB_TOKEN }} -------------------------------------------------------------------------------- /.github/workflows/docker.yml: -------------------------------------------------------------------------------- 1 | name: Docker Build 2 | 3 | on: 4 | workflow_run: 5 | workflows: ["Test"] 6 | types: 7 | - completed 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | if: ${{ github.event.workflow_run.conclusion == 'success' }} 13 | steps: 14 | - name: Check out the repo 15 | uses: actions/checkout@v3 16 | 17 | - name: Log in to Docker Hub 18 | uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9 19 | with: 20 | username: ${{ secrets.DOCKER_USERNAME }} 21 | password: ${{ secrets.DOCKER_PASSWORD }} 22 | 23 | - 24 | name: Set up QEMU 25 | uses: docker/setup-qemu-action@v1 26 | - 27 | name: Set up Docker Buildx 28 | uses: docker/setup-buildx-action@v1 29 | 30 | - name: Extract metadata (tags, labels) for Docker 31 | id: meta 32 | uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38 33 | with: 34 | images: bmswens/meshtastic-web-api 35 | tags: type=raw,value={{sha}} 36 | 37 | - name: Set outputs 38 | id: vars 39 | run: echo "::set-output name=sha_short::$(git rev-parse --short HEAD)" 40 | 41 | - name: Build and push Docker image 42 | uses: docker/build-push-action@v2 43 | with: 44 | context: . 45 | push: true 46 | platforms: linux/amd64,linux/arm/v7 47 | tags: ${{ steps.meta.outputs.tags }} 48 | labels: ${{ steps.meta.outputs.labels }} -------------------------------------------------------------------------------- /.github/workflows/pages.yml: -------------------------------------------------------------------------------- 1 | name: Build Github Pages 2 | 3 | on: 4 | workflow_run: 5 | workflows: ["Test"] 6 | types: 7 | - completed 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v3 14 | - uses: actions/setup-python@v4 15 | with: 16 | python-version: '3.10' 17 | - uses: actions/setup-node@v3 18 | with: 19 | node-version: 16 20 | - run: pip install -r requirements.txt 21 | - run: python ./src/app.py --export 22 | - run: npm install -g redoc-cli 23 | - run: redoc-cli bundle -o index.html swagger.json 24 | - uses: EndBug/add-and-commit@v9 # You can change this to use a specific version. 25 | with: 26 | add: '.' 27 | 28 | # The name of the user that will be displayed as the author of the commit. 29 | # Default: depends on the default_author input 30 | author_name: Brandon Swenson 31 | 32 | # The email of the user that will be displayed as the author of the commit. 33 | # Default: depends on the default_author input 34 | author_email: bmswens@gmail.com 35 | 36 | # The message for the commit. 37 | # Default: 'Commit from GitHub Actions (name of the workflow)' 38 | message: 'Update documentation pages' 39 | 40 | # If this input is set, the action will push the commit to a new branch with this name. 41 | # Default: '' 42 | new_branch: pages 43 | 44 | push: --force --set-upstream origin pages 45 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # venv 2 | venv 3 | 4 | # python 5 | __pycache__ 6 | *\__pycache__ 7 | *.egg-info 8 | .pytest_cache 9 | 10 | # testing 11 | .coverage 12 | coverage 13 | 14 | # database 15 | *.sqlite 16 | swagger.json 17 | data 18 | 19 | # env 20 | .env -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.11.1 2 | 3 | LABEL maintainer="bmswens@gmail.com" 4 | LABEL vcs-url="https://github.com/bmswens/Meshtastic-Web-API" 5 | LABEL docs-url="https://bmswens.github.io/Meshtastic-Web-API/" 6 | 7 | WORKDIR /app 8 | RUN mkdir data 9 | COPY ./requirements.txt ./ 10 | RUN pip install -r requirements.txt 11 | COPY ./src ./src 12 | 13 | ENTRYPOINT ["/bin/bash", "/app/src/entrypoint.sh"] -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Meshtastic Web API 2 | 3 | [![Docs](https://img.shields.io/badge/Docs-Deployed-brightgreen)](https://bmswens.github.io/Meshtastic-Web-API/) 4 | [![Test](https://github.com/bmswens/Meshtastic-REST-API/actions/workflows/Test.yml/badge.svg)](https://github.com/bmswens/Meshtastic-REST-API/actions/workflows/Test.yml) 5 | [![Coverage Status](https://coveralls.io/repos/github/bmswens/Meshtastic-Web-API/badge.svg?branch=main)](https://coveralls.io/github/bmswens/Meshtastic-Web-API?branch=main) 6 | [![Docker Build](https://img.shields.io/badge/Docker%20Build-Automated-brightgreen)](https://github.com/bmswens/Meshtastic-Web-API/actions/workflows/docker.yml) 7 | [![Docker Pulls](https://img.shields.io/docker/pulls/bmswens/meshtastic-web-api)](https://hub.docker.com/repository/docker/bmswens/meshtastic-web-api) 8 | [![License](https://img.shields.io/github/license/bmswens/Meshtastic-REST-API)](https://github.com/bmswens/Meshtastic-REST-API/blob/master/LICENSE) 9 | 10 | 11 | --- 12 | ## Overview 13 | A web-based API to be hosted on devices connected to a [Meshtastic](https://github.com/meshtastic) node via serial connection. 14 | 15 | ## Documentation 16 | 17 | ### Wiki 18 | Documentation on installation, configuration, usage, and more can be found [on the wiki](https://github.com/bmswens/Meshtastic-Web-API/wiki). 19 | 20 | ### Github Pages 21 | Searchable documentation is deployed on Github pages and can be found [here](https://bmswens.github.io/Meshtastic-Web-API/). 22 | 23 | ### Local Deployments 24 | Endpoints are documented using [Swagger](https://swagger.io/) via [RestX](https://flask-restx.readthedocs.io/en/latest/index.html) at the root URL and can be executed from there. 25 | 26 | ## Plans 27 | - [ ] Implement all Python CLI functionality via HTTP 28 | - [ ] Add websocket support for real time chat functionality 29 | 30 | ## Authors 31 | 32 | * **Brandon Swenson**- *Initial work* - [bmswens](https://github.com/bmswens) 33 | 34 | ## License 35 | 36 | This project, like Meshtastic, is licensed under the GNU General Public License - see the [LICENSE.txt](LICENSE.txt) file for details 37 | -------------------------------------------------------------------------------- /bin/docker-start.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | docker run \ 3 | -p 5000:5000 \ 4 | --privileged \ 5 | -v ./data:/app/data \ 6 | bmswens/meshtastic-web-api -------------------------------------------------------------------------------- /bin/test.ps1: -------------------------------------------------------------------------------- 1 | .\venv\Scripts\pytest.exe --cov=src --cov-report term-missing -------------------------------------------------------------------------------- /env.test: -------------------------------------------------------------------------------- 1 | MATTERMOST_ENABLED=TRUE 2 | MATTERMOST_TOKEN=XYZ -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | aniso8601==9.0.1 2 | attrs==22.1.0 3 | black==22.12.0 4 | certifi==2022.12.7 5 | charset-normalizer==3.1.0 6 | click==8.1.3 7 | colorama==0.4.6 8 | coverage==7.0.0 9 | dotmap==1.3.30 10 | enum-compat==0.0.3 11 | exceptiongroup==1.0.4 12 | Flask==2.2.2 13 | flask-restx==1.0.3 14 | idna==3.4 15 | importlib-metadata==5.2.0 16 | iniconfig==1.1.1 17 | itsdangerous==2.1.2 18 | Jinja2==3.1.2 19 | jsonschema==4.17.3 20 | MarkupSafe==2.1.1 21 | meshtastic==2.0.6 22 | mypy-extensions==0.4.3 23 | packaging==22.0 24 | pathspec==0.10.3 25 | pexpect==4.8.0 26 | platformdirs==2.6.0 27 | pluggy==1.0.0 28 | protobuf==4.21.12 29 | ptyprocess==0.7.0 30 | pygatt==4.0.5 31 | Pypubsub==4.0.3 32 | PyQRCode==1.2.1 33 | pyrsistent==0.19.2 34 | pyserial==3.5 35 | pytest==7.2.0 36 | pytest-cov==4.0.0 37 | pytz==2022.7 38 | PyYAML==6.0 39 | requests==2.29.0 40 | requests-mock==1.10.0 41 | six==1.16.0 42 | tabulate==0.9.0 43 | timeago==1.0.16 44 | tomli==2.0.1 45 | typing_extensions==4.4.0 46 | urllib3==1.26.15 47 | Werkzeug==2.2.2 48 | zipp==3.11.0 49 | -------------------------------------------------------------------------------- /src/api/__init__.py: -------------------------------------------------------------------------------- 1 | # 3rd party 2 | from flask_restx import Api 3 | 4 | # custom 5 | from .nodeInfo import api as nodeInfo 6 | from .localConfig import api as localConfig 7 | from .serialPort import api as serialPort 8 | from .messages import api as messages 9 | from .cannedMessageModule import api as cannedMessage 10 | from .positions import api as positions 11 | from .mattermost import api as mattermost 12 | 13 | api = Api( 14 | title="Meshtastic Web API", 15 | version="0.1", 16 | description="A web interface for interacting with a Meshtastic node over serial connection.", 17 | contact="bmswens@gmail.com", 18 | license="GNU GENERAL PUBLIC LICENSE", 19 | license_url="https://github.com/bmswens/Meshtastic-REST-API/blob/main/LICENSE", 20 | ) 21 | 22 | api.add_namespace(nodeInfo, path="/node-info") 23 | api.add_namespace(localConfig, path="/local-config") 24 | api.add_namespace(serialPort, path="/serial-port") 25 | api.add_namespace(messages, path="/messages") 26 | api.add_namespace(cannedMessage, path="/canned-message-module-config") 27 | api.add_namespace(positions, path="/positions") 28 | api.add_namespace(mattermost, path="/mattermost") 29 | -------------------------------------------------------------------------------- /src/api/cannedMessageModule.py: -------------------------------------------------------------------------------- 1 | # 3rd party 2 | from flask import current_app, request 3 | from flask_restx import Namespace, Resource, fields, marshal 4 | 5 | api = Namespace( 6 | "Canned Message Module Config", description="Canned message module configuration." 7 | ) 8 | 9 | canned_message_model = api.model( 10 | "Canned Message Config", 11 | { 12 | "messages": fields.String( 13 | description="Predefined messages for canned message module separated by '|' characters.", 14 | required=True, 15 | example="My new message", 16 | ) 17 | }, 18 | ) 19 | 20 | 21 | @api.route("") 22 | class CannedMessage(Resource): 23 | @api.doc(description="Get the current canned message") 24 | @api.marshal_with(canned_message_model) 25 | def get(self): 26 | message = current_app.interface.localNode.get_canned_message() 27 | message = message[message.find("'") + 1 : message.rfind("'")] 28 | return {"messages": message} 29 | 30 | @api.doc(description="Update the current canned message") 31 | @api.expect(canned_message_model) 32 | def post(self): 33 | body = request.json 34 | if "messages" not in body: 35 | return {"message": "Missing 'messages' in body"}, 400 36 | localNode = current_app.interface.localNode 37 | localNode.set_canned_message(body["messages"]) 38 | return {"messages": body["messages"]} 39 | -------------------------------------------------------------------------------- /src/api/localConfig.py: -------------------------------------------------------------------------------- 1 | # 3rd party 2 | from flask import current_app, request 3 | from flask_restx import Namespace, Resource, fields 4 | from meshtastic import __main__ as meshtastic 5 | import yaml 6 | 7 | 8 | api = Namespace("Local Config", description="Config operations") 9 | 10 | abstractConfig = api.model("AbstractConfig", {"*": fields.Wildcard(fields.String)}) 11 | 12 | configModel = api.model( 13 | "Config", 14 | { 15 | "owner": fields.String, 16 | "owner_short": fields.String, 17 | "ownerShort": fields.String(attribute="owner_short"), 18 | "channel_url": fields.String, 19 | "channelUrl": fields.String(attribute="channel_url"), 20 | "location": fields.Nested( 21 | api.model( 22 | "Location", 23 | {"alt": fields.Integer, "lat": fields.Float, "lon": fields.Float}, 24 | ) 25 | ), 26 | "config": fields.Nested(abstractConfig), 27 | "module_config": fields.Nested(abstractConfig), 28 | }, 29 | ) 30 | 31 | 32 | @api.route("") 33 | class LocalConfig(Resource): 34 | @api.doc(description="Returns the configuration of the node connected via serial.") 35 | def get(self): 36 | config_text = meshtastic.export_config(current_app.interface) 37 | output = yaml.safe_load(config_text) 38 | return output 39 | 40 | @api.doc( 41 | description="Update the current configuration", 42 | ) 43 | @api.expect(configModel) 44 | def post(self): 45 | configuration = request.json 46 | interface = current_app.interface 47 | node_id = interface.getMyUser()["id"] 48 | # following code reused from meshtastic.__main__ 49 | # Line 399; if args.configure 50 | interface.getNode(node_id, False).beginSettingsTransaction() 51 | 52 | if "owner" in configuration: 53 | interface.getNode(node_id, False).setOwner(configuration["owner"]) 54 | 55 | if "owner_short" in configuration: 56 | interface.getNode(node_id, False).setOwner( 57 | long_name=None, short_name=configuration["owner_short"] 58 | ) 59 | 60 | if "channel_url" in configuration: 61 | interface.getNode(node_id).setURL(configuration["channel_url"]) 62 | 63 | if "location" in configuration: 64 | alt = 0 65 | lat = 0.0 66 | lon = 0.0 67 | localConfig = interface.localNode.localConfig 68 | 69 | if "alt" in configuration["location"]: 70 | alt = int(configuration["location"]["alt"]) 71 | localConfig.position.fixed_position = True 72 | if "lat" in configuration["location"]: 73 | lat = float(configuration["location"]["lat"]) 74 | localConfig.position.fixed_position = True 75 | if "lon" in configuration["location"]: 76 | lon = float(configuration["location"]["lon"]) 77 | localConfig.position.fixed_position = True 78 | interface.sendPosition(lat, lon, alt) 79 | interface.localNode.writeConfig("position") 80 | 81 | if "config" in configuration: 82 | localConfig = interface.getNode(node_id).localConfig 83 | for section in configuration["config"]: 84 | for pref in configuration["config"][section]: 85 | meshtastic.setPref( 86 | localConfig, 87 | f"{section}.{pref}", 88 | str(configuration["config"][section][pref]), 89 | ) 90 | interface.getNode(node_id).writeConfig(section) 91 | 92 | if "module_config" in configuration: 93 | moduleConfig = interface.getNode(node_id).moduleConfig 94 | for section in configuration["module_config"]: 95 | for pref in configuration["module_config"][section]: 96 | meshtastic.setPref( 97 | moduleConfig, 98 | f"{section}.{pref}", 99 | str(configuration["module_config"][section][pref]), 100 | ) 101 | interface.getNode(node_id).writeConfig(section) 102 | 103 | interface.getNode(node_id, False).commitSettingsTransaction() 104 | return "success" 105 | -------------------------------------------------------------------------------- /src/api/mattermost.py: -------------------------------------------------------------------------------- 1 | # built in 2 | import os 3 | 4 | # 3rd party 5 | from flask import current_app, request 6 | from flask_restx import Namespace, Resource, fields, marshal 7 | import requests 8 | 9 | api = Namespace("Mattermost", description="Extend Mattermost messages to Meshtastic.") 10 | 11 | mattermostModel = api.model( 12 | "From Mattermost", 13 | { 14 | "channel_id": fields.String( 15 | required=False, 16 | example="hawos4dqtby53pd64o4a4cmeoo", 17 | description="Mattermost Channel ID" 18 | ), 19 | "channel_name": fields.String( 20 | required=False, 21 | example="town-square", 22 | description="Mattermost Channel Name" 23 | ), 24 | "team_domain": fields.String( 25 | required=False, 26 | example="someteam", 27 | description="Mattermost Team Name" 28 | ), 29 | "team_id": fields.String( 30 | required=False, 31 | example="kwoknj9nwpypzgzy78wkw516qe", 32 | description="Mattermost Team ID" 33 | ), 34 | "post_id": fields.String( 35 | required=False, 36 | example="axdygg1957njfe5pu38saikdho", 37 | description="Mattermost Post ID" 38 | ), 39 | "text": fields.String( 40 | required=True, 41 | example="some+text+here", 42 | description="Text to send to Meshtastic" 43 | ), 44 | "timestamp": fields.Integer( 45 | required=False, 46 | example=1445532266, 47 | description="Mattermost timestamp for message" 48 | ), 49 | "token": fields.String( 50 | required=True, 51 | example="zmigewsanbbsdf59xnmduzypjc", 52 | description="Mattermost token, changes per deployment" 53 | ), 54 | "trigger_word": fields.String( 55 | required=False, 56 | example="some", 57 | description="Trigger word that activated the webhook" 58 | ), 59 | "user_id": fields.String( 60 | required=False, 61 | example="rnina9994bde8mua79zqcg5hmo", 62 | description="Mattermost User ID" 63 | ), 64 | "user_name": fields.String( 65 | required=True, 66 | example="somename", 67 | description="Mattermost Usernam" 68 | ) 69 | } 70 | ) 71 | 72 | @api.route("") 73 | class MattermostMessage(Resource): 74 | @api.doc(description="Send a message from Mattermost to Meshtastic") 75 | @api.expect(mattermostModel) 76 | def post(self): 77 | interface = current_app.interface 78 | from_mattermost = marshal(request.json, mattermostModel) 79 | if not from_mattermost["text"]: 80 | return {"message": "'text' must be in body"}, 400 81 | if os.getenv("MATTERMOST_TOKEN") != from_mattermost["token"]: 82 | return {"message": "token does not match"}, 403 83 | text = f'FROM: {from_mattermost["user_name"]}\n{from_mattermost["text"]}' 84 | interface.sendText(text=text, wantAck=True) 85 | return {"message": "success"}, 200 86 | 87 | 88 | def onMessage(packet, interface): 89 | sender = packet["fromId"] 90 | text = packet["decoded"]["payload"].decode() 91 | senderName = sender 92 | nodes = interface.nodes 93 | # try and get a long name for the sender 94 | for nodeNum in nodes: 95 | nodeInfo = nodes[nodeNum] 96 | if nodeNum == sender: 97 | senderName = nodeInfo["user"].get("longName") 98 | # post that data 99 | body = { 100 | "text": text, 101 | "username": senderName 102 | } 103 | url = os.getenv("MATTERMOST_WEBHOOK") 104 | requests.post(url, json=body) -------------------------------------------------------------------------------- /src/api/messages.py: -------------------------------------------------------------------------------- 1 | # 3rd party 2 | from flask import current_app, request 3 | from flask_restx import Namespace, Resource, fields, marshal 4 | 5 | api = Namespace("Messages", description="Sending and recieving text messages") 6 | 7 | messageModel = api.model( 8 | "Sent Message", 9 | { 10 | "text": fields.String( 11 | required=True, example="Hello world!", description="The text to send" 12 | ), 13 | "destinationId": fields.String( 14 | default="^all", description="Where to send this message" 15 | ), 16 | "wantAck": fields.Boolean( 17 | default=True, 18 | description="If you want the message sent in a reliable manner (with retries and ack/nak provided for delivery)", 19 | ), 20 | "wantResponse": fields.Boolean( 21 | default=False, 22 | description="If you want the service on the other side to send an application layer response", 23 | ), 24 | "channelIndex": fields.Integer( 25 | default=0, description="The channel to send the message on" 26 | ), 27 | }, 28 | ) 29 | 30 | recMessageModel = api.model( 31 | "Recieved Message", 32 | { 33 | "uuid": fields.Integer(description="Interal database UUID"), 34 | "sender": fields.String( 35 | description="The ID of the sender", example="!9388f81c" 36 | ), 37 | "target": fields.String( 38 | description="Intended target of the message", example="^all" 39 | ), 40 | "text": fields.String( 41 | description="The content of the message", example="Hello world!" 42 | ), 43 | "channel": fields.Integer(description="The channel index", example="0"), 44 | "timestamp": fields.DateTime( 45 | description="ISO8601 formatted datetime", 46 | example="2022-12-23T14:51:15.784133", 47 | ), 48 | }, 49 | ) 50 | 51 | 52 | @api.route("") 53 | class TextMessage(Resource): 54 | @api.doc(description="Send a message on a channel, defaults to primary channel") 55 | @api.expect(messageModel) 56 | def post(self): 57 | interface = current_app.interface 58 | localNode = interface.localNode 59 | message = marshal(request.json, messageModel) 60 | channelIndex = message["channelIndex"] 61 | if not message["text"]: 62 | return {"message": "'text' must be in body"}, 400 63 | elif channelIndex < 0 or channelIndex > len(localNode.channels) - 1: 64 | return {"message": f"channelIndex {channelIndex} out of range"}, 400 65 | # channelSettings objects are empty when converted to strings if unconfigured 66 | elif not str(localNode.channels[channelIndex].settings): 67 | return {"message": f"Channel {channelIndex} not configured"}, 404 68 | interface.sendText(**message) 69 | return {"message": "success"}, 200 70 | 71 | @api.doc(description="Get messages stored in the database") 72 | @api.marshal_with(recMessageModel) 73 | @api.param("dm", description="Shows only direct messages") 74 | @api.param("limit", description="Limit how many messages to output") 75 | def get(self): 76 | interface = current_app.interface 77 | params = request.args.to_dict() 78 | dm = None 79 | if "dm" in params: 80 | user = interface.getMyUser() 81 | dm = user["id"] 82 | limit = params.get("limit") 83 | with current_app.db as db: 84 | messages = db.get_messages(limit, dm) 85 | return messages 86 | -------------------------------------------------------------------------------- /src/api/nodeInfo.py: -------------------------------------------------------------------------------- 1 | # 3rd party 2 | from flask import current_app, request 3 | from flask_restx import Namespace, Resource, fields 4 | 5 | api = Namespace("Node Info", description="Information about the node(s)") 6 | 7 | # Node Info Models 8 | 9 | PositionModel = api.model( 10 | "Position", 11 | { 12 | "altitude": fields.Integer, 13 | "latitude": fields.Float, 14 | "longitude": fields.Float, 15 | "time": fields.Integer, 16 | }, 17 | ) 18 | 19 | UserModel = api.model( 20 | "User", 21 | { 22 | "id": fields.String( 23 | example="!55c77c48", description="Predefined ID for the device." 24 | ), 25 | "longName": fields.String( 26 | example="Meshtastic Device 1", 27 | description="User defined long name of the device.", 28 | ), 29 | "shortName": fields.String( 30 | example="MD1", description="User defined short name of the device." 31 | ), 32 | "macaddr": fields.String( 33 | example="lLVVx3xI", description="Predfined mac address for th device." 34 | ), 35 | "hwModel": fields.String( 36 | example="TBEAM", description="predefined hardware model of th device." 37 | ), 38 | }, 39 | ) 40 | 41 | DeviceMetricsModel = api.model( 42 | "Device Metrics", 43 | { 44 | "batteryLevel": fields.Integer( 45 | example=77, description="The battery level of the device." 46 | ), 47 | "voltage": fields.Float( 48 | example=4.159, description="The current voltage of the device." 49 | ), 50 | "channelUtilization": fields.Float( 51 | example=5.4733334, description="Current channel utilization." 52 | ), 53 | "airUtilTx": fields.Float(example=3.154972, description="I'm not quite sure."), 54 | }, 55 | ) 56 | 57 | NodeInfoModel = api.model( 58 | "Node Info", 59 | { 60 | "num": fields.Integer( 61 | example=1439136840, description="Serial number of the device." 62 | ), 63 | "user": fields.Nested(UserModel), 64 | "position": fields.Nested(PositionModel), 65 | "lastHeard": fields.Integer( 66 | example=1671952630, 67 | description="Time the node was last heard, as seconds since epoch.", 68 | ), 69 | "deviceMetrics": fields.Nested(DeviceMetricsModel), 70 | }, 71 | ) 72 | 73 | 74 | @api.route("") 75 | class NodeInfo(Resource): 76 | @api.doc(description="Returns all the known nodes as list.") 77 | @api.marshal_with(NodeInfoModel) 78 | def get(self): 79 | nodes = current_app.interface.nodes 80 | return [nodes[node] for node in nodes] 81 | 82 | 83 | @api.route("/") 84 | class SingleNodeInfo(Resource): 85 | @api.doc( 86 | description="Returns info of a node in JSON format.", 87 | params={"node": "The Node ID, Long Name, Short Name, or MAC Address."}, 88 | responses={200: "OK", 404: "Node not found"}, 89 | ) 90 | @api.marshal_with(NodeInfoModel) 91 | def get(self, node): 92 | nodes = current_app.interface.nodes 93 | for nodeNum in nodes: 94 | nodeInfo = nodes[nodeNum] 95 | accepted_names = [ 96 | nodeNum, 97 | nodeInfo["user"].get("longName"), 98 | nodeInfo["user"].get("shortName"), 99 | nodeInfo["user"].get("macaddr"), 100 | ] 101 | if node in accepted_names: 102 | return nodeInfo, 200 103 | return {"message": "Node not found"}, 404 104 | -------------------------------------------------------------------------------- /src/api/positions.py: -------------------------------------------------------------------------------- 1 | # 3rd party 2 | from flask import current_app, request 3 | from flask_restx import Namespace, Resource, fields, marshal 4 | 5 | api = Namespace( 6 | "Positions", description="Get information about the positions of nodes." 7 | ) 8 | 9 | # models 10 | PositionModel = api.model( 11 | "Position", 12 | { 13 | "uuid": fields.Integer( 14 | description="Interal UUID of the record.", example=111234 15 | ), 16 | "sender": fields.String( 17 | description="Node that the position is for.", example="!55c77c48" 18 | ), 19 | "target": fields.String( 20 | description="Who the position update was intended for, often '^all'.", 21 | example="^all", 22 | ), 23 | "altitude": fields.Integer(description="Altitude of the node.", example=327), 24 | "latitude": fields.Float( 25 | description="Latitude of the node, in decimal degrees.", example=33.5415 26 | ), 27 | "longitude": fields.Float( 28 | description="Longitude of the node, in decimal degrees.", example=112.3755 29 | ), 30 | "timestamp": fields.DateTime( 31 | description="ISO8601 formatted datetime", 32 | example="2022-12-23T14:51:15.784133", 33 | ), 34 | }, 35 | ) 36 | 37 | 38 | @api.route("") 39 | class Positions(Resource): 40 | @api.doc(description="Get position entries from the database, most recent first.") 41 | @api.marshal_with(PositionModel) 42 | def get(self): 43 | with current_app.db as db: 44 | return db.get_positions() 45 | 46 | @api.route("/") 47 | class NodePosition(Resource): 48 | @api.doc(description="Get the positions of a single node, by name, ID, etc.") 49 | @api.marshal_with(PositionModel) 50 | def get(self, node): 51 | interface = current_app.interface 52 | if node not in interface.nodes: 53 | found = False 54 | for nodeId in interface.nodes: 55 | nodeInfo = interface.nodes[nodeId] 56 | names = [ 57 | nodeInfo['user']["longName"], 58 | nodeInfo['user']['shortName'], 59 | nodeInfo['user']['macaddr'] 60 | ] 61 | if node in names: 62 | found = True 63 | node = nodeId 64 | break 65 | if not found: 66 | return {}, 404 67 | with current_app.db as db: 68 | return db.get_positions(node=node) 69 | -------------------------------------------------------------------------------- /src/api/serialPort.py: -------------------------------------------------------------------------------- 1 | # 3rd party 2 | from flask import current_app 3 | from flask_restx import Namespace, Resource, fields 4 | 5 | api = Namespace("Serial Port", description="Information about the serial connection") 6 | 7 | portModel = api.model( 8 | "Port", {"port": fields.String(example="COM4, /dev/ttyUSB0, etc.")} 9 | ) 10 | 11 | 12 | @api.route("") 13 | class Port(Resource): 14 | @api.doc( 15 | description="Returns JSON containing the port the device is connected on.", 16 | ) 17 | @api.response(200, "Success", portModel) 18 | def get(self): 19 | return {"port": current_app.interface.devPath} 20 | -------------------------------------------------------------------------------- /src/app.py: -------------------------------------------------------------------------------- 1 | # built in 2 | import argparse 3 | import json 4 | import os 5 | 6 | # 3rd party 7 | from flask import Flask 8 | import meshtastic.serial_interface 9 | 10 | # custom 11 | from api import api 12 | import db 13 | 14 | 15 | def create_app(connect=True): 16 | # flask init 17 | app = Flask(__name__) 18 | # meshtastic interface that all sub modules will use 19 | interface = None 20 | if connect: 21 | interface = meshtastic.serial_interface.SerialInterface() 22 | db_path = db.start() 23 | app.interface = interface 24 | app.db = db.Database(db_path) 25 | api.init_app(app) 26 | return app, api 27 | 28 | 29 | if __name__ == "__main__": # pragma: no cover 30 | parser = argparse.ArgumentParser( 31 | description="Start the server or export the swagger.json" 32 | ) 33 | parser.add_argument("--export", nargs="?", dest="export", default=False, const=True) 34 | args = parser.parse_args() 35 | if args.export: 36 | app, api = create_app(False) 37 | app.config["SERVER_NAME"] = "bmswens.github.io/Meshtastic-Web-API/" 38 | with app.app_context(): 39 | with open("swagger.json", "w") as output: 40 | output.write(json.dumps(api.__schema__, indent=2)) 41 | else: 42 | app, api = create_app() 43 | app.run(host="0.0.0.0") 44 | -------------------------------------------------------------------------------- /src/db.py: -------------------------------------------------------------------------------- 1 | # built in 2 | import os 3 | import sqlite3 4 | import datetime 5 | 6 | # 3rd party 7 | import meshtastic.serial_interface 8 | from pubsub import pub 9 | 10 | # custom 11 | from api.mattermost import onMessage as mmOnMessage 12 | 13 | 14 | def dict_factory(cursor, row): 15 | fields = [column[0] for column in cursor.description] 16 | return {key: value for key, value in zip(fields, row)} 17 | 18 | 19 | class Database: 20 | def __init__(self, path): 21 | self.path = path 22 | self.connection = None 23 | self.cursor = None 24 | 25 | def __enter__(self): 26 | self.connection = sqlite3.connect(self.path) 27 | self.connection.row_factory = dict_factory 28 | self.cursor = self.connection.cursor() 29 | self.cursor.execute( 30 | """ 31 | CREATE TABLE IF NOT EXISTS messages ( 32 | uuid INTEGER, 33 | sender TEXT, 34 | target TEXT, 35 | text TEXT, 36 | channel INTEGER, 37 | timestamp TEXT 38 | ); 39 | """ 40 | ) 41 | self.cursor.execute( 42 | """ 43 | CREATE TABLE IF NOT EXISTS positions ( 44 | uuid INTEGER, 45 | sender TEXT, 46 | target TEXT, 47 | altitude INTEGER, 48 | longitude REAL, 49 | latitude REAL, 50 | timestamp TEXT 51 | ); 52 | """ 53 | ) 54 | return self 55 | 56 | def __exit__(self, exception_type, exception_value, exception_traceback): 57 | self.connection.commit() 58 | self.connection.close() 59 | self.connection = None 60 | self.cursor = None 61 | 62 | def insert_message(self, uuid, sender, target, text, channel, timestamp): 63 | if not self.connection: 64 | raise RuntimeError( 65 | 'No connection found, please use `with Database("/path") as db:` syntax' 66 | ) 67 | self.cursor.execute( 68 | "INSERT INTO messages VALUES (?, ?, ?, ?, ?, ?);", 69 | [uuid, sender, target, text, channel, timestamp], 70 | ) 71 | 72 | def get_messages(self, limit=None, dm=None): 73 | if not self.connection: 74 | raise RuntimeError( 75 | 'No connection found, please use `with Database("/path") as db:` syntax' 76 | ) 77 | results = None 78 | if not limit and not dm: 79 | results = self.cursor.execute( 80 | "SELECT * FROM messages ORDER BY timestamp DESC;" 81 | ) 82 | elif limit: 83 | results = self.cursor.execute( 84 | "SELECT * FROM messages ORDER BY timestamp DESC LIMIT ?;", [limit] 85 | ) 86 | elif dm: 87 | results = self.cursor.execute( 88 | "SELECT * FROM messages WHERE target=? ORDER BY timestamp DESC;", [dm] 89 | ) 90 | return [row for row in results] 91 | 92 | def insert_position( 93 | self, uuid, sender, target, altitude, latitude, longitude, timestamp 94 | ): 95 | if not self.connection: 96 | raise RuntimeError( 97 | 'No connection found, please use `with Database("/path") as db:` syntax' 98 | ) 99 | self.cursor.execute( 100 | "INSERT INTO positions VALUES (?, ?, ?, ?, ?, ?, ?);", 101 | [uuid, sender, target, altitude, latitude, longitude, timestamp], 102 | ) 103 | 104 | def get_positions(self, node=None, limit=None): 105 | if not self.connection: 106 | raise RuntimeError( 107 | 'No connection found, please use `with Database("/path") as db:` syntax' 108 | ) 109 | 110 | query = "SELECT * FROM positions ORDER BY timestamp DESC;" 111 | args = [] 112 | if node: 113 | query = "SELECT * FROM positions WHERE sender = ? ORDER BY timestamp DESC;" 114 | args.append(node) 115 | results = self.cursor.execute( 116 | query, 117 | args 118 | ) 119 | return [row for row in results] 120 | 121 | 122 | def onMessage(packet, interface, db_path=None): 123 | if not db_path: # pragma: no cover 124 | db_path = get_db_path() 125 | uuid = packet["id"] 126 | sender = packet["fromId"] 127 | target = packet["toId"] 128 | text = packet["decoded"]["payload"].decode() 129 | channel = packet.get("channel", 0) 130 | timestamp = datetime.datetime.now() 131 | rxTime = packet.get("rxTime") 132 | if rxTime: 133 | timestamp = datetime.datetime.fromtimestamp(rxTime) 134 | timestamp = timestamp.isoformat() 135 | with Database(db_path) as db: 136 | db.insert_message(uuid, sender, target, text, channel, timestamp) 137 | 138 | # mattermost integration 139 | mattermost_url = os.getenv("MATTERMOST_WEBHOOK") 140 | if mattermost_url: 141 | mmOnMessage(packet, interface) 142 | 143 | 144 | def onPosition(packet, interface, db_path=None): 145 | if not db_path: # pragma: no cover 146 | db_path = get_db_path() 147 | uuid = packet["id"] 148 | sender = packet["fromId"] 149 | target = packet["toId"] 150 | position = packet["decoded"]["position"] 151 | altitude = position["altitude"] 152 | longitude = position["longitude"] 153 | latitude = position["latitude"] 154 | timestamp = datetime.datetime.fromtimestamp(packet["rxTime"]) 155 | timestamp = timestamp.isoformat() 156 | with Database(db_path) as db: 157 | db.insert_position( 158 | uuid, sender, target, altitude, latitude, longitude, timestamp 159 | ) 160 | 161 | 162 | def get_db_path(): 163 | this_dir = os.path.dirname(os.path.abspath(__file__)) 164 | data_dir = os.path.join(os.path.dirname(this_dir), "data") 165 | os.makedirs(data_dir, exist_ok=True) 166 | db_path = os.path.join(data_dir, "db.sqlite") 167 | return db_path 168 | 169 | 170 | def start(): 171 | """For use in the main app""" 172 | pub.subscribe(onMessage, "meshtastic.receive.text") 173 | pub.subscribe(onPosition, "meshtastic.receive.position") 174 | return get_db_path() 175 | 176 | 177 | if __name__ == "__main__": # pragma: no cover 178 | interface = meshtastic.serial_interface.SerialInterface() 179 | while True: 180 | pub.subscribe(onMessage, "meshtastic.receive.text") 181 | pub.subscribe(onPosition, "meshtastic.receive.position") 182 | -------------------------------------------------------------------------------- /src/entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | sleep 30 3 | python /app/src/app.py -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- 1 | # built in 2 | import os 3 | from unittest.mock import MagicMock 4 | import datetime 5 | 6 | # 3rd party 7 | from meshtastic.serial_interface import SerialInterface 8 | from meshtastic.mesh_interface import MeshInterface 9 | from meshtastic.node import Node 10 | from meshtastic.channel_pb2 import Channel 11 | import pytest 12 | 13 | # custom 14 | # add to os.sys.path so that we don't have to make a package 15 | this_dir = os.path.dirname(os.path.abspath(__file__)) 16 | src_dir = os.path.join(os.path.dirname(this_dir), "src") 17 | os.sys.path.append(src_dir) 18 | from app import create_app 19 | import db 20 | 21 | 22 | @pytest.fixture() 23 | def app(): 24 | # mock SerialInterface to always return a MeshInterface whithout 25 | # trying to connect over serial 26 | SerialInterface.__init__ = lambda x: None 27 | 28 | app, api = create_app() 29 | app.config.update( 30 | { 31 | "TESTING": True, 32 | } 33 | ) 34 | 35 | # mock out the meshtastic interface 36 | # code yoinked from meshtastic tests 37 | iface = MagicMock(autospec=MeshInterface) 38 | anode = Node("foo", "bar") 39 | 40 | nodes = { 41 | "!9388f81c": { 42 | "num": 2475227164, 43 | "user": { 44 | "id": "!9388f81c", 45 | "longName": "Unknown f81c", 46 | "shortName": "?1C", 47 | "macaddr": "RBeTiPgc", 48 | "hwModel": "TBEAM", 49 | }, 50 | "position": {}, 51 | "lastHeard": 1640204888, 52 | }, 53 | "SN1": { 54 | "num": 2475227164, 55 | "user": { 56 | "id": "SN1", 57 | "longName": "Unknown f81c", 58 | "shortName": "UF81", 59 | "macaddr": "RBeTiPgc", 60 | "hwModel": "TBEAM", 61 | }, 62 | "position": {"raw": "bad data"}, 63 | "lastHeard": 1640204888, 64 | }, 65 | } 66 | 67 | iface.nodesByNum = {1: anode} 68 | iface.nodes = nodes 69 | iface.devPath = "COM4" 70 | 71 | myInfo = MagicMock(return_value=nodes["!9388f81c"]) 72 | iface.myInfo = myInfo 73 | 74 | getMyUser = MagicMock(return_value=nodes["!9388f81c"]["user"]) 75 | iface.getMyUser = getMyUser 76 | 77 | # local node 78 | iface.localNode = MagicMock(autospec=Node) 79 | mock_canned_message = "canned_plugin_message:test\n'test'" 80 | iface.localNode.get_canned_message = MagicMock(return_value=mock_canned_message) 81 | iface.localNode.channels = [ 82 | MagicMock(autospec=Channel), 83 | MagicMock(autospec=Channel), 84 | Channel(), 85 | ] 86 | 87 | app.interface = iface 88 | 89 | # db setup 90 | app.db = db.Database("test.sqlite") 91 | with app.db as database: 92 | database.insert_message( 93 | 1, 94 | "sender2", 95 | "!9388f81c", 96 | "first message", 97 | 1, 98 | datetime.datetime(year=2022, month=12, day=18).isoformat(), 99 | ) 100 | database.insert_message( 101 | 1, "sender1", "^all", "testing", 0, datetime.datetime.now().isoformat() 102 | ) 103 | database.insert_position( 104 | 1, 105 | "sender1", 106 | "^all", 107 | 1, 108 | 1, 109 | 1, 110 | datetime.datetime(year=2022, month=12, day=18).isoformat(), 111 | ) 112 | database.insert_position( 113 | 2, "SN1", "^all", 1, 1, 1, datetime.datetime.now().isoformat() 114 | ) 115 | # other setup can go here 116 | 117 | yield app 118 | 119 | # clean up / reset resources here 120 | os.remove("test.sqlite") 121 | 122 | 123 | @pytest.fixture() 124 | def client(app): 125 | return app.test_client() 126 | 127 | 128 | @pytest.fixture() 129 | def runner(app): 130 | return app.test_cli_runner() 131 | -------------------------------------------------------------------------------- /tests/test_config.py: -------------------------------------------------------------------------------- 1 | # built in 2 | from unittest.mock import MagicMock 3 | 4 | # to mock 5 | from meshtastic import __main__ as meshtastic 6 | 7 | 8 | class TestConfig: 9 | def test_get_config(self, client): 10 | meshtastic.export_config = MagicMock( 11 | return_value=""" 12 | # start of Meshtastic configure yaml 13 | channel_url: https://meshtastic.org/e/#CisSIEmJyqAo4UOYKV7QI0yge-nVHsXD9BZy03SUHMHgCNVfGgdTd2Vuc29uEgoIATgBQANIAVAe 14 | config: 15 | bluetooth: 16 | enabled: true 17 | fixedPin: 123456 18 | device: 19 | serialEnabled: true 20 | display: 21 | screenOnSecs: 600 22 | lora: 23 | hopLimit: 3 24 | region: US 25 | txEnabled: true 26 | txPower: 30 27 | usePreset: true 28 | network: 29 | ntpServer: 0.pool.ntp.org 30 | position: 31 | gpsAttemptTime: 900 32 | gpsEnabled: true 33 | gpsUpdateInterval: 120 34 | positionBroadcastSecs: 30 35 | positionBroadcastSmartEnabled: true 36 | positionFlags: 3 37 | rxGpio: 34 38 | txGpio: 12 39 | power: 40 | lsSecs: 300 41 | meshSdsTimeoutSecs: 7200 42 | minWakeSecs: 10 43 | sdsSecs: 4294967295 44 | waitBluetoothSecs: 60 45 | location: 46 | alt: 100 47 | lat: 42 48 | lon: -88 49 | module_config: 50 | mqtt: 51 | address: mqtt.meshtastic.org 52 | password: large4cats 53 | username: meshdev 54 | rangeTest: 55 | sender: 30 56 | telemetry: 57 | deviceUpdateInterval: 900 58 | environmentUpdateInterval: 900 59 | owner: Swenson Node 0 60 | owner_short: SN0 61 | """ 62 | ) 63 | resp = client.get("/local-config") 64 | assert resp.status_code == 200 65 | required_keys = [ 66 | "channel_url", 67 | "config", 68 | "location", 69 | "module_config", 70 | "owner", 71 | "owner_short", 72 | ] 73 | for key in required_keys: 74 | assert key in resp.json.keys() 75 | 76 | def test_post_full_config(self, client): 77 | body = { 78 | "owner": "Swenson Node 0", 79 | "owner_short": "SN0", 80 | "channel_url": "http://meshtastic.org/asdfadsf", 81 | "location": {"alt": 0, "lat": 0, "lon": 0}, 82 | "config": { 83 | "section": { 84 | "ignore_incoming": "string", 85 | } 86 | }, 87 | "module_config": { 88 | "section": { 89 | "ignore_incoming": "string", 90 | } 91 | }, 92 | } 93 | resp = client.post("/local-config", json=body) 94 | assert resp.status_code == 200 95 | 96 | 97 | class TestCannedMessage: 98 | def test_get_message(self, client): 99 | resp = client.get("/canned-message-module-config") 100 | assert resp.status_code == 200 101 | assert resp.json == {"messages": "test"} 102 | 103 | def test_post_message(self, client): 104 | body = {"messages": "New Test"} 105 | resp = client.post("/canned-message-module-config", json=body) 106 | assert resp.status_code == 200 107 | assert resp.json == body 108 | 109 | def test_bad_post_message(self, client): 110 | body = {"fake": "data"} 111 | resp = client.post("/canned-message-module-config", json=body) 112 | assert resp.status_code == 400 113 | -------------------------------------------------------------------------------- /tests/test_db.py: -------------------------------------------------------------------------------- 1 | # built in 2 | import os 3 | import datetime 4 | from unittest.mock import MagicMock 5 | 6 | # 3rd party 7 | from pubsub import pub 8 | import pytest 9 | from meshtastic.mesh_interface import MeshInterface 10 | 11 | # custom 12 | # add to os.sys.path so that we don't have to make a package 13 | this_dir = os.path.dirname(os.path.abspath(__file__)) 14 | src_dir = os.path.join(os.path.dirname(this_dir), "src") 15 | os.sys.path.append(src_dir) 16 | import db 17 | 18 | 19 | class TestDB: 20 | def test_bad_connect(self): 21 | d = db.Database(":memory:") 22 | with pytest.raises(RuntimeError): 23 | d.insert_message(1, 1, 2, "test", 0, datetime.datetime.now().isoformat()) 24 | with pytest.raises(RuntimeError): 25 | d.get_messages() 26 | with pytest.raises(RuntimeError): 27 | d.get_positions() 28 | with pytest.raises(RuntimeError): 29 | d.insert_position(1, 1, 1, 1, 1, 1, datetime.datetime.now().isoformat()) 30 | 31 | def test_insert_message(self): 32 | with db.Database(":memory:") as d: 33 | d.insert_message(1, 1, 2, "test", 0, datetime.datetime.now().isoformat()) 34 | 35 | def test_insert_position(self): 36 | with db.Database(":memory:") as d: 37 | d.insert_position(1, 1, 1, 1, 1, 1, datetime.datetime.now().isoformat()) 38 | 39 | def test_rec_msg(self, requests_mock): 40 | # TODO: Figure out how to test this better 41 | db.start() 42 | packet = { 43 | "id": 1, 44 | "fromId": 1, 45 | "toId": 2, 46 | "decoded": {"payload": b"test"}, 47 | "rxTime": 2, 48 | } 49 | interface = MagicMock(autospec=MeshInterface) 50 | nodes = { 51 | "1": { 52 | "user": { 53 | "longName": "John" 54 | } 55 | } 56 | } 57 | interface.nodes = nodes 58 | requests_mock.post("http://test.com/api/x", json={"message": "success"}) 59 | db.onMessage(packet, interface, ":memory:") 60 | 61 | def test_rec_position(self): 62 | packet = { 63 | "id": 1, 64 | "fromId": 1, 65 | "toId": 2, 66 | "decoded": {"position": {"altitude": 0, "latitude": 0, "longitude": 0}}, 67 | "rxTime": 3, 68 | } 69 | db.onPosition(packet, {}, ":memory:") 70 | -------------------------------------------------------------------------------- /tests/test_mattermost.py: -------------------------------------------------------------------------------- 1 | class TestSendMessage: 2 | def test_no_text(self, client): 3 | body = { 4 | "user_name": "bmswens", 5 | "token": "XYZ" 6 | } 7 | resp = client.post('/mattermost', json=body) 8 | assert resp.status_code == 400 9 | def test_no_token(self, client): 10 | body = { 11 | "user_name": "bmswens", 12 | "text": "123" 13 | } 14 | resp = client.post('/mattermost', json=body) 15 | assert resp.status_code == 403 16 | def test_full_send(self, client): 17 | body = { 18 | "user_name": "bmswens", 19 | "token": "XYZ", 20 | "text": "123" 21 | } 22 | resp = client.post('/mattermost', json=body) 23 | assert resp.status_code == 200 24 | -------------------------------------------------------------------------------- /tests/test_nodes.py: -------------------------------------------------------------------------------- 1 | class TestGetNode: 2 | def test_existing_node(self, client): 3 | resp = client.get("/node-info/!9388f81c") 4 | assert resp.status_code == 200 5 | assert resp.json["user"]["id"] == "!9388f81c" 6 | 7 | def test_remove_raw(self, client): 8 | resp = client.get("/node-info/SN1") 9 | assert resp.status_code == 200 10 | assert resp.json["position"].get("raw") == None 11 | 12 | def test_non_existant_node(self, client): 13 | resp = client.get("/node-info/fakeSerial") 14 | assert resp.status_code == 404 15 | 16 | 17 | class TestGetAllNodes: 18 | def test_all_nodes(self, client): 19 | resp = client.get("/node-info") 20 | assert resp.status_code == 200 21 | mockNodes = [ 22 | { 23 | "num": 2475227164, 24 | "user": { 25 | "id": "!9388f81c", 26 | "longName": "Unknown f81c", 27 | "shortName": "?1C", 28 | "macaddr": "RBeTiPgc", 29 | "hwModel": "TBEAM", 30 | }, 31 | "deviceMetrics": None, 32 | "position": { 33 | "altitude": None, 34 | "latitude": None, 35 | "longitude": None, 36 | "time": None, 37 | }, 38 | "lastHeard": 1640204888, 39 | "deviceMetrics": { 40 | "batteryLevel": None, 41 | "voltage": None, 42 | "channelUtilization": None, 43 | "airUtilTx": None, 44 | }, 45 | }, 46 | { 47 | "num": 2475227164, 48 | "user": { 49 | "id": "SN1", 50 | "longName": "Unknown f81c", 51 | "shortName": "UF81", 52 | "macaddr": "RBeTiPgc", 53 | "hwModel": "TBEAM", 54 | }, 55 | "deviceMetrics": None, 56 | "position": { 57 | "altitude": None, 58 | "latitude": None, 59 | "longitude": None, 60 | "time": None, 61 | }, 62 | "lastHeard": 1640204888, 63 | "deviceMetrics": { 64 | "batteryLevel": None, 65 | "voltage": None, 66 | "channelUtilization": None, 67 | "airUtilTx": None, 68 | }, 69 | }, 70 | ] 71 | print(resp.json) 72 | assert resp.json == mockNodes 73 | -------------------------------------------------------------------------------- /tests/test_positions.py: -------------------------------------------------------------------------------- 1 | class TestPositions: 2 | def test_get_all(self, client): 3 | resp = client.get("/positions") 4 | assert resp.status_code == 200 5 | assert len(resp.json) == 2 6 | 7 | def test_get_by_node(self, client): 8 | resp = client.get("/positions/UF81") 9 | assert resp.status_code == 200 10 | assert len(resp.json) == 1 11 | assert resp.json[0]["uuid"] == 2 12 | 13 | def test_get_bad_node(self, client): 14 | resp = client.get("/positions/nope") 15 | assert resp.status_code == 404 -------------------------------------------------------------------------------- /tests/test_serial.py: -------------------------------------------------------------------------------- 1 | class TestPort: 2 | def test_get_port(self, client): 3 | resp = client.get("/serial-port") 4 | assert resp.status_code == 200 5 | assert resp.json == {"port": "COM4"} 6 | -------------------------------------------------------------------------------- /tests/test_text.py: -------------------------------------------------------------------------------- 1 | class TestSendText: 2 | def test_bad_message(self, client): 3 | body = {"fake": "data"} 4 | resp = client.post("/messages", json=body) 5 | assert resp.status_code == 400 6 | 7 | def test_channeless_send(self, client): 8 | body = {"text": "testing"} 9 | resp = client.post("/messages", json=body) 10 | assert resp.status_code == 200 11 | 12 | def test_bad_channel_send(self, client): 13 | body = {"text": "testing", "channelIndex": 100} 14 | resp = client.post("/messages", json=body) 15 | assert resp.status_code == 400 16 | 17 | def test_unconfig_channel_send(self, client): 18 | body = {"text": "testing", "channelIndex": 2} 19 | resp = client.post("/messages", json=body) 20 | assert resp.status_code == 404 21 | 22 | def test_channel_send(self, client): 23 | body = {"text": "testing", "channelIndex": 1} 24 | resp = client.post("/messages", json=body) 25 | assert resp.status_code == 200 26 | 27 | 28 | class TestGetText: 29 | def test_get_all(self, client): 30 | resp = client.get("/messages") 31 | assert resp.status_code == 200 32 | assert len(resp.json) == 2 33 | 34 | def test_get_by_dm(self, client): 35 | resp = client.get("/messages?dm=true") 36 | assert resp.status_code == 200 37 | assert len(resp.json) == 1 38 | assert resp.json[0]["text"] == "first message" 39 | 40 | def test_get_messages_limit(self, client): 41 | resp = client.get("/messages?limit=1") 42 | assert resp.status_code == 200 43 | assert len(resp.json) == 1 44 | assert resp.json[0]["text"] == "testing" 45 | --------------------------------------------------------------------------------