diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..d9a10c0 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..dd968bb --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,19 @@ +Copyright 2024 Martin Michaelis + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the “Software”), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e53cba0 --- /dev/null +++ b/README.md @@ -0,0 +1,126 @@ +[![CI](../../actions/workflows/ci.yaml/badge.svg)](../../actions/workflows/ci.yaml) + +# Badge Magic in Rust + +Library and CLI to configure LED badges. + +## Installation + +As of now there are no releases of this tool. + +The latest commit on the main branch gets released automatically. + +You can download the latest version on the [release page](../../releases/latest). Depending on your operating system pick the matching file: + +Operating System | File +-|- +Linux (GNU / 64 bit) | `badgemagic.x86_64-unknown-linux-gnu` +Windows (64 bit) | `rust-github-actions-test.x86_64-pc-windows-msvc.exe ` +MacOS (Intel) | `rust-github-actions-test.x86_64-apple-darwin` +MacOS (M1, etc.) | `rust-github-actions-test.aarch64-apple-darwin` + +```sh +# After the download rename the file to `badgemagic` +mv badgemagic. badgemagic + +# Make the program executable (linux / macOS only) +chmod +x badgemagic + +# Test that it works +./badgemagic --help +``` + +> Note: The windows and macOS build is not actively tested. Please try it out and report back whether it worked or any problems that might occour. + +If your system is not listed above (Linux / Windows on ARM, musl, etc.) or you want to do it anyway, you can install this tool from source: + +```sh +cargo install --git https://github.com/fossasia/badgemagic-rs --features cli +badgemagic --help +``` + +Or clone the repo and run the CLI: +```sh +git clone https://github.com/fossasia/badgemagic-rs +cd badgemagic-rs +cargo run --features cli -- --help +``` + +## Usage + +Execute the `badgemagic` tool and pass the file name of your configuration file. Depending on how you installed the tool: + +```sh +# Downloaded from release page +./badgemagic config.toml + +# Installed with cargo install +badgemagic config.toml + +# Run from git repository +cargo run --features cli -- config.toml +``` + +The above command will read your configuration from a file named `config.toml` in the current directory. + +## Configuration + +You can have a look at the example configurations in the [`demo` Directory](demo). + +The TOML configuration consits of up to 8 message sections starting with `[[message]]`. + +Each message can have the following options: +```toml +[[message]] +# Enable blink mode +blink = true +# Show a dotted border arround the display +border = true +# Set the update speed of the animations (0 to 7) +speed = 6 +# Set the display animation (left, right, up, down, center, fast, drop, curtain, laser) +mode = "left" +# The text to show on the display +text = "Lorem ipsum dolor sit amet." +``` + +You can omit options you don't need: +```toml +[[message]] +mode = "center" +text = "Hello" +``` + +If you want you can "draw" images as ascii art (`_` = Off, `X` = On): +```toml +[[message]] +mode = "center" +bitstring = """ +___XXXXX___ +__X_____X__ +_X_______X_ +X__XX_XX__X +X__XX_XX__X +X_________X +X_XX___XX_X +X__XXXXX__X +_X__XXX__X_ +__X_____X__ +___XXXXX___ +""" +``` + +You just replace the `text` option with `bitstring`. All other options (e.g. `border`, `blink`) still work and can be combined with a custom image. + +## License + +Licensed under either of + +- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. diff --git a/demo/effects.toml b/demo/effects.toml new file mode 100644 index 0000000..263294b --- /dev/null +++ b/demo/effects.toml @@ -0,0 +1,32 @@ +[[message]] +blink = true +border = true +mode = "center" +text = "Hello" + +[[message]] +mode = "laser" +text = "Laser" + +[[message]] +mode = "drop" +text = "Drop" + +[[message]] +mode = "curtain" +text = "Curtain" + +[[message]] +mode = "left" +text = "Move message left" + +[[message]] +mode = "up" +text = "Move up" + +[[message]] +blink = true +border = true +speed = 6 +mode = "left" +text = "Combine them all and add some speed... might be a bit overwhelming" diff --git a/demo/jump.toml b/demo/jump.toml new file mode 100644 index 0000000..41dff0a --- /dev/null +++ b/demo/jump.toml @@ -0,0 +1,16 @@ +[[message]] +speed = 6 +mode = "fast" +bitstring = """ +X__________________________________________X____X__________________________________________X____X___________________XXXX___________________X____X__________________________________________X +_X________________________________________X______X__________________XXXX__________________X______X_________________X____X_________________X______X__________________XXXX__________________X_ +__X_________________XXXX_________________X________X________________X____X________________X________X_____________X__X____X__X_____________X________X________________X____X________________X__ +___________________X____X__________________________________________X____X________________________________________X__XXXX__X________________________________________X____X___________________ +___________________X____X___________________________________________XXXX__________________________________________XXXXXXXX__________________________________________XXXX____________________ +____________________XXXX_______________________________________XXXXXXXXXXXXXX________________________________________X_________________________________________XXXXXXXXXXXXXX_______________ +__________________XXXXXXXX___________________________________________X______________________________________________X_X______________________________________________X______________________ +_________________X___X____X_________________________________________X_X____________________________________________X___X____________________________________________X_X_____________________ +__X_____________X___X_X____X_____________X________X________________X___X_________________X________X_______________X_____X________________X________X________________X___X_________________X__ +_X_________________X___X__________________X______X________________X_____X_________________X______X________________________________________X______X________________X_____X_________________X_ +X_________________X_____X__________________X____X__________________________________________X____X__________________________________________X____X__________________________________________X +""" diff --git a/demo/smiley.toml b/demo/smiley.toml new file mode 100644 index 0000000..67f99f3 --- /dev/null +++ b/demo/smiley.toml @@ -0,0 +1,15 @@ +[[message]] +mode = "center" +bitstring = """ +___XXXXX___ +__X_____X__ +_X_______X_ +X__XX_XX__X +X__XX_XX__X +X_________X +X_XX___XX_X +X__XXXXX__X +_X__XXX__X_ +__X_____X__ +___XXXXX___ +"""