From 841306674adb47c6eeffb8c2a7689da2aa6577e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Tr=C3=B3jniak?= Date: Wed, 18 Sep 2024 00:01:20 +0200 Subject: [PATCH] feat: display inversion command MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add display inversion command. Add inversion example with changing screen inversion without redrawing it (basically blinking the screen). Signed-off-by: Rafał Trójniak --- examples/ssd1306_inversion_example/LICENSE | 190 ++++++++++++++++++ examples/ssd1306_inversion_example/README.md | 10 + .../ssd1306_inversion_example/rebar.config | 5 + .../src/ssd1306_inversion_example.app.src | 12 ++ .../src/ssd1306_inversion_example.erl | 44 ++++ nifs/atomvm_ssd1306.c | 63 ++++++ src/ssd1306.erl | 22 +- 7 files changed, 345 insertions(+), 1 deletion(-) create mode 100644 examples/ssd1306_inversion_example/LICENSE create mode 100644 examples/ssd1306_inversion_example/README.md create mode 100644 examples/ssd1306_inversion_example/rebar.config create mode 100644 examples/ssd1306_inversion_example/src/ssd1306_inversion_example.app.src create mode 100644 examples/ssd1306_inversion_example/src/ssd1306_inversion_example.erl diff --git a/examples/ssd1306_inversion_example/LICENSE b/examples/ssd1306_inversion_example/LICENSE new file mode 100644 index 0000000..efdacd2 --- /dev/null +++ b/examples/ssd1306_inversion_example/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, Fred Dushin . + + 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/examples/ssd1306_inversion_example/README.md b/examples/ssd1306_inversion_example/README.md new file mode 100644 index 0000000..165802a --- /dev/null +++ b/examples/ssd1306_inversion_example/README.md @@ -0,0 +1,10 @@ +# `ssd1306_inversion_example` + +This small example shows how you can inverse the screen display without affecting other contents of the display. + +When display is invested, all bits with value `1` are interpreted as pixel turned off, while bits with value `0` are pixels turned on. + +For this application, you will need the same setup and tools as with the main `ssd1306_example` project. +Please refer to README.md there. + +If all goes according to plan, congratulations -- your SSD1306 display should be alternating between text on black background and black text on bright background every second. diff --git a/examples/ssd1306_inversion_example/rebar.config b/examples/ssd1306_inversion_example/rebar.config new file mode 100644 index 0000000..494ad9e --- /dev/null +++ b/examples/ssd1306_inversion_example/rebar.config @@ -0,0 +1,5 @@ +{erl_opts, [debug_info]}. +{deps, [ + {atomvm_ssd1306, {git, "https://github.com/atomvm/atomvm_ssd1306.git", {branch, "master"}}} +]}. +{plugins, [atomvm_rebar3_plugin]}. diff --git a/examples/ssd1306_inversion_example/src/ssd1306_inversion_example.app.src b/examples/ssd1306_inversion_example/src/ssd1306_inversion_example.app.src new file mode 100644 index 0000000..416fd86 --- /dev/null +++ b/examples/ssd1306_inversion_example/src/ssd1306_inversion_example.app.src @@ -0,0 +1,12 @@ +{application, ssd1306_inversion_example, [ + {description, "An OTP library"}, + {vsn, "0.1.0"}, + {registered, []}, + {applications, [ + kernel, stdlib + ]}, + {env,[]}, + {modules, []}, + {licenses, ["Apache 2.0"]}, + {links, []} + ]}. diff --git a/examples/ssd1306_inversion_example/src/ssd1306_inversion_example.erl b/examples/ssd1306_inversion_example/src/ssd1306_inversion_example.erl new file mode 100644 index 0000000..cf596de --- /dev/null +++ b/examples/ssd1306_inversion_example/src/ssd1306_inversion_example.erl @@ -0,0 +1,44 @@ +%% +%% Copyright (c) 2021 dushin.net +%% 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(ssd1306_inversion_example). + +-export([start/0]). + +start() -> + SSD1306Config = #{ + sda_pin => 21, + scl_pin => 22 + }, + {ok, SSD1306} = ssd1306:start(SSD1306Config), + ssd1306:clear(SSD1306), + ssd1306:set_contrast(SSD1306, 255), + loop(SSD1306). + + +loop(SSD1306) -> + Text = io_lib:format( + " !!AtomVM!!~n~nFree heap:~n~p bytes~n", + [erlang:system_info(esp32_free_heap_size) ] + ), + io:format("Displaying text: ~s~n", [Text]), + ssd1306:clear(SSD1306), + ssd1306:set_text(SSD1306, Text), + ssd1306:set_inversion(SSD1306, true), + timer:sleep(1000), + ssd1306:set_inversion(SSD1306, false), + timer:sleep(1000), + loop(SSD1306). diff --git a/nifs/atomvm_ssd1306.c b/nifs/atomvm_ssd1306.c index 54968a5..55ddb35 100644 --- a/nifs/atomvm_ssd1306.c +++ b/nifs/atomvm_ssd1306.c @@ -138,6 +138,23 @@ static esp_err_t init_ssd1306_command(i2c_port_t i2c_num) return err; } + + +static esp_err_t set_display_inverted_command(i2c_port_t i2c_num, bool inversion_mode) +{ + + uint8_t command = inversion_mode? OLED_CMD_DISPLAY_INVERTED : OLED_CMD_DISPLAY_NORMAL; + i2c_cmd_handle_t cmd = i2c_cmd_link_create(); + i2c_master_start(cmd); + I2C_MASTER_WRITE_BYTE(cmd, (OLED_I2C_ADDRESS << 1) | I2C_MASTER_WRITE, true); + I2C_MASTER_WRITE_BYTE(cmd, OLED_CONTROL_BYTE_CMD_STREAM, true); + I2C_MASTER_WRITE_BYTE(cmd, command , true); + i2c_master_stop(cmd); + esp_err_t err = i2c_master_cmd_begin(i2c_num, cmd, MASTER_COMMAND_TIMEOUT_MS); + i2c_cmd_link_delete(cmd); + return err; +} + static term nif_ssd1306_init(Context *ctx, int argc, term argv[]) { TRACE(TAG ": nif_ssd1306_init\n"); @@ -215,6 +232,43 @@ static esp_err_t write_page_command(i2c_port_t i2c_num, uint8_t *page, uint8_t p return err; } +static term nif_ssd1306_set_inversion(Context *ctx, int argc, term argv[]) +{ + TRACE(TAG ": nif_ssd1306_set_inversion\n"); + UNUSED(argc); + + term i2c_num_term = argv[0]; + VALIDATE_VALUE(i2c_num_term, term_is_atom); + term mode_term = argv[1]; + VALIDATE_VALUE(i2c_num_term, term_is_atom); + + i2c_port_t i2c_num = get_i2c_port_num(ctx->global, i2c_num_term); + if (i2c_num == I2C_NUM_MAX) { + ESP_LOGE(TAG, "Invalid I2C portnum"); + RAISE_ERROR(BADARG_ATOM); + } + + bool inversion_mode; + switch(term_to_atom_index(mode_term)) { + case TRUE_ATOM_INDEX: + inversion_mode = true; + break; + case FALSE_ATOM_INDEX: + inversion_mode = false; + break; + default: + ESP_LOGE(TAG, "Invalid inversion mode"); + RAISE_ERROR(BADARG_ATOM); + } + + esp_err_t err = set_display_inverted_command(i2c_num, inversion_mode); + if (err != ESP_OK) { + ESP_LOGW(TAG, "Failed to set display inverted. Error: %i", err); + } + + return OK_ATOM; +} + static term nif_ssd1306_clear(Context *ctx, int argc, term argv[]) { TRACE(TAG ": nif_ssd1306_clear\n"); @@ -497,6 +551,11 @@ static const struct Nif ssd1306_init_nif = .base.type = NIFFunctionType, .nif_ptr = nif_ssd1306_init }; +static const struct Nif ssd1306_set_inversion = +{ + .base.type = NIFFunctionType, + .nif_ptr = nif_ssd1306_set_inversion +}; static const struct Nif ssd1306_clear_nif = { .base.type = NIFFunctionType, @@ -534,6 +593,10 @@ const struct Nif *atomvm_ssd1306_get_nif(const char *nifname) TRACE("Resolved platform nif %s ...\n", nifname); return &ssd1306_init_nif; } + if (strcmp("ssd1306:nif_set_inversion/2", nifname) == 0) { + TRACE("Resolved platform nif %s ...\n", nifname); + return &ssd1306_set_inversion; + } if (strcmp("ssd1306:nif_clear/1", nifname) == 0) { TRACE("Resolved platform nif %s ...\n", nifname); return &ssd1306_clear_nif; diff --git a/src/ssd1306.erl b/src/ssd1306.erl index e353790..bf474bd 100644 --- a/src/ssd1306.erl +++ b/src/ssd1306.erl @@ -27,7 +27,7 @@ -behaviour(gen_server). --export([start/1, stop/1, clear/1, set_contrast/2, set_text/2, set_bitmap/4, set_qrcode/2]). +-export([start/1, stop/1, clear/1, set_inversion/2, set_contrast/2, set_text/2, set_bitmap/4, set_qrcode/2]). -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). -export([nif_init/1, nif_clear/1, nif_set_contrast/2, nif_set_text/2, nif_set_bitmap/4, nif_set_qrcode/2]). @@ -84,6 +84,20 @@ stop(SSD1306) -> clear(SSD1306) -> gen_server:call(SSD1306, clear). +%%----------------------------------------------------------------------------- +%% @param SSD1306 a reference to the SSD1306 instance created via start +%% @param Mode sets the inversion active (true) or not active(false - normal) +%% @returns ok | {error, Reason} +%% @doc Sets the screen inversion mode +%% +%% When executed, will set screen inversion mode +%% either to inverted (true), or normal (false) +%% @end +%%----------------------------------------------------------------------------- +-spec set_inversion(SSD1306::ssd1306(), Mode::boolean()) -> ok | {error, Reason::term()}. +set_inversion(SSD1306, Mode) -> + gen_server:call(SSD1306, {set_inversion, Mode}). + %%----------------------------------------------------------------------------- %% @param SSD1306 a reference to the SSD1306 instance created via start %% @returns ok | {error, Reason} @@ -179,6 +193,8 @@ handle_cast(_Msg, State) -> {noreply, State}. %% @hidden +handle_call({set_inversion, Mode}, From, #state{use_nif=true} = State) -> + {reply, ?MODULE:nif_set_inversion(State#state.i2c_num, Mode), State}; handle_call(clear, _From, #state{use_nif=true} = State) -> {reply, ?MODULE:nif_clear(State#state.i2c_num), State}; % handle_call(clear, _From, State) -> @@ -484,6 +500,10 @@ code_change(_OldVsn, State, _Extra) -> nif_init(_Config) -> throw(nif_error). +%% @hidden +nif_set_inversion(_I2CNum, _mode) -> + throw(nif_error). + %% @hidden nif_clear(_I2CNum) -> throw(nif_error).