From bb19bfad0e0fe3d4168f3546d6f3d423baa7e25c Mon Sep 17 00:00:00 2001 From: dudemanbro Date: Fri, 22 Dec 2023 16:26:29 -0500 Subject: [PATCH] add msg_blinker demo --- demos/msg_blinker/LICENSE | 190 ++++++++++++++++++++++ demos/msg_blinker/README.md | 34 ++++ demos/msg_blinker/rebar.config | 7 + demos/msg_blinker/rebar.lock | 4 + demos/msg_blinker/src/msg_blinker.app.src | 12 ++ demos/msg_blinker/src/msg_blinker.erl | 33 ++++ demos/msg_blinker/src/receiver.erl | 40 +++++ demos/msg_blinker/src/sender.erl | 29 ++++ 8 files changed, 349 insertions(+) create mode 100644 demos/msg_blinker/LICENSE create mode 100644 demos/msg_blinker/README.md create mode 100644 demos/msg_blinker/rebar.config create mode 100644 demos/msg_blinker/rebar.lock create mode 100644 demos/msg_blinker/src/msg_blinker.app.src create mode 100644 demos/msg_blinker/src/msg_blinker.erl create mode 100644 demos/msg_blinker/src/receiver.erl create mode 100644 demos/msg_blinker/src/sender.erl diff --git a/demos/msg_blinker/LICENSE b/demos/msg_blinker/LICENSE new file mode 100644 index 0000000..b31f115 --- /dev/null +++ b/demos/msg_blinker/LICENSE @@ -0,0 +1,190 @@ + 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 + + Copyright 2020, Alex Whitney + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/demos/msg_blinker/README.md b/demos/msg_blinker/README.md new file mode 100644 index 0000000..78aea98 --- /dev/null +++ b/demos/msg_blinker/README.md @@ -0,0 +1,34 @@ +# `msg_blinker` Application + +Welcome to the `msg_blinker` AtomVM application. + +The `msg_blinker` AtomVM application will start two processes. The sender process will send an on and off message to the receiver process every 2 seconds. The receiver process with blink an LED attached to pin 2 on and off depending on whether it receives an on or off message. + +> Note. This example program has only been tested to run on the `esp32` platform. + +To run this example, depending on how bright you want your led, connect a 220 ohm to 1k ohm resistor in series with a 3.3v LED between IO pin 2 and GND. + + +-----------+ + | | 330 ohm + | IO2 o--- \/\/\/\ ---+ + | | resistor | + | | | + | | | + | | | + | GND o------|<-------+ + +-----------+ LED + ESP32 + +> ESP32 Note. Many ESP32 development boards already attach pin 2 to an on-board LED. + +## Supported Platforms + +| Platform | Supported | +|----------------|-----------| +| `esp32` | ✓ | +| `stm32` | ✗ | +| `generic_unix` | ✗ | + +For more information about programming on the AtomVM platform, see the [AtomVM Programmers Guide](https://www.atomvm.net/doc/master/programmers-guide.html). + +For general information about building and executing Erlang AtomVM example programs, see the Erlang example program [README](../README.md). diff --git a/demos/msg_blinker/rebar.config b/demos/msg_blinker/rebar.config new file mode 100644 index 0000000..6040fbd --- /dev/null +++ b/demos/msg_blinker/rebar.config @@ -0,0 +1,7 @@ +{erl_opts, [debug_info]}. +{deps, [ + {atomvm_lib, {git, "https://github.com/atomvm/atomvm_lib.git", {branch, "master"}}} +]}. +{plugins, [ + atomvm_rebar3_plugin +]}. diff --git a/demos/msg_blinker/rebar.lock b/demos/msg_blinker/rebar.lock new file mode 100644 index 0000000..c237cd6 --- /dev/null +++ b/demos/msg_blinker/rebar.lock @@ -0,0 +1,4 @@ +[{<<"atomvm_lib">>, + {git,"https://github.com/atomvm/atomvm_lib.git", + {ref,"987d1a9a5fdf5244e43e8940e5dcac0a934c0503"}}, + 0}]. diff --git a/demos/msg_blinker/src/msg_blinker.app.src b/demos/msg_blinker/src/msg_blinker.app.src new file mode 100644 index 0000000..208cea5 --- /dev/null +++ b/demos/msg_blinker/src/msg_blinker.app.src @@ -0,0 +1,12 @@ +{application, msg_blinker, [ + {description, "An OTP library"}, + {vsn, "0.1.0"}, + {registered, []}, + {applications, [ + kernel, stdlib + ]}, + {env, []}, + {modules, []}, + {licenses, ["Apache 2.0"]}, + {links, []} +]}. diff --git a/demos/msg_blinker/src/msg_blinker.erl b/demos/msg_blinker/src/msg_blinker.erl new file mode 100644 index 0000000..51200e7 --- /dev/null +++ b/demos/msg_blinker/src/msg_blinker.erl @@ -0,0 +1,33 @@ +% +% This file is part of AtomVM. +% +% Copyright (c) 2023 Alex Whitney +% All rights reserved. +% +% Licensed under the Apache License, Version 2.0 (the "License"); +% you may not use this file except in compliance with the License. +% You may obtain a copy of the License at +% +% http://www.apache.org/licenses/LICENSE-2.0 +% +% Unless required by applicable law or agreed to in writing, software +% distributed under the License is distributed on an "AS IS" BASIS, +% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +% See the License for the specific language governing permissions and +% limitations under the License. +% + +-module(msg_blinker). + +-export([start/0]). +start() -> + Pid1 = spawn(receiver, run, []), + register(receiver, Pid1), + Pid2 = spawn(sender, send_messages, []), + register(sender, Pid2), + wait_forever(). + +wait_forever() -> + receive + X -> X + end. diff --git a/demos/msg_blinker/src/receiver.erl b/demos/msg_blinker/src/receiver.erl new file mode 100644 index 0000000..c2aeb73 --- /dev/null +++ b/demos/msg_blinker/src/receiver.erl @@ -0,0 +1,40 @@ +% +% This file is part of AtomVM. +% +% Copyright (c) 2023 Alex Whitney +% All rights reserved. +% +% Licensed under the Apache License, Version 2.0 (the "License"); +% you may not use this file except in compliance with the License. +% You may obtain a copy of the License at +% +% http://www.apache.org/licenses/LICENSE-2.0 +% +% Unless required by applicable law or agreed to in writing, software +% distributed under the License is distributed on an "AS IS" BASIS, +% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +% See the License for the specific language governing permissions and +% limitations under the License. +% + +-module(receiver). +-export([run/0, handle_message/2]). + +run() -> + GPIO = gpio:open(), + gpio:set_direction(GPIO, 2, output), + handle_message(GPIO, off). + +handle_message(GPIO, State) -> + receive + on -> + gpio:set_level(GPIO, 2, 1), + io:format("Turned on GPIO pin 2~n"), + handle_message(GPIO, on); + off -> + gpio:set_level(GPIO, 2, 0), + io:format("Turned off GPIO pin 2~n"), + handle_message(GPIO, off) + after 0 -> + handle_message(GPIO, State) + end. diff --git a/demos/msg_blinker/src/sender.erl b/demos/msg_blinker/src/sender.erl new file mode 100644 index 0000000..9d07670 --- /dev/null +++ b/demos/msg_blinker/src/sender.erl @@ -0,0 +1,29 @@ +% +% This file is part of AtomVM. +% +% Copyright (c) 2023 Alex Whitney +% All rights reserved. +% +% Licensed under the Apache License, Version 2.0 (the "License"); +% you may not use this file except in compliance with the License. +% You may obtain a copy of the License at +% +% http://www.apache.org/licenses/LICENSE-2.0 +% +% Unless required by applicable law or agreed to in writing, software +% distributed under the License is distributed on an "AS IS" BASIS, +% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +% See the License for the specific language governing permissions and +% limitations under the License. +% + +-module(sender). +-export([send_messages/0]). + +send_messages() -> + ReceiverPid = whereis(receiver), + ReceiverPid ! on, + timer:sleep(2000), + ReceiverPid ! off, + timer:sleep(2000), + send_messages().