Update API and add How To Use example

Also update README to point to documentation.

.clang-format

@@ -3,13 +3,22 @@
 ---
 BasedOnStyle:  WebKit
 StatementMacros:
-- M5_NIF_v_v
-- M5_NIF_v_i
+- M5_NIF_b_v
+- M5_NIF_f_f2_v
 - M5_NIF_i_v
+- M5_NIF_i2_i2u_v
 - M5_NIF_i2_v
+- M5_NIF_i3_i3u_v
 - M5_NIF_i3_v
-- M5_NIF_i2_i3_v
-- M5_NIF_i3_i4_v
-- M5_NIF_i4_i5_v
-- M5_NIF_i5_i6_v
-- M5_NIF_i6_i7_v
+- M5_NIF_i4_i4u_v
+- M5_NIF_i4_v
+- M5_NIF_i5_i5u_v
+- M5_NIF_i6_i6u_v
+- M5_NIF_si2_i
+- M5_NIF_u_v
+- M5_NIF_v_3b
+- M5_NIF_v_b
+- M5_NIF_v_i
+- M5_NIF_v_i4
+- M5_NIF_v_u_v
+- M5_NIF_v_v

CMakeLists.txt

@@ -2,8 +2,10 @@
 
 set(ATOMVM_M5_COMPONENT_SRCS
     "nifs/atomvm_m5.cc"
+    "nifs/atomvm_m5_btn.cc"
     "nifs/atomvm_m5_display.cc"
     "nifs/atomvm_m5_i2c.cc"
+    "nifs/atomvm_m5_imu.cc"
     "nifs/atomvm_m5_power.cc"
     "nifs/atomvm_m5_power_axp192.cc"
     "nifs/atomvm_m5_rtc.cc"

Kconfig

@@ -6,6 +6,12 @@ config AVM_M5_ENABLE
 	help
 		Use this parameter to enable or disable the AtomVM M5 driver.
 
+config AVM_M5_BTN_ENABLE
+	bool  "Enable AtomVM M5 driver button API"
+	default y
+	help
+		Use this parameter to enable or disable the AtomVM M5 driver button API.
+
 config AVM_M5_DISPLAY_ENABLE
 	bool  "Enable AtomVM M5 driver display API"
 	default y
@@ -30,6 +36,12 @@ config AVM_M5_I2C_ENABLE
 	help
 		Use this parameter to enable or disable the AtomVM M5 driver I2C API.
 
+config AVM_M5_IMU_ENABLE
+	bool  "Enable AtomVM M5 driver IMU API"
+	default y
+	help
+		Use this parameter to enable or disable the AtomVM M5 driver IMU API.
+
 config AVM_M5_RTC_ENABLE
         bool  "Enable AtomVM M5 driver RTC API"
         default y

README.md

@@ -13,14 +13,4 @@ This project is a port of M5Unified for the AtomVM platform.
 
 ## Usage
 
-The following modules are currently defined:
-
-```
-m5
-m5_display
-m5_i2c
-m5_power
-m5_power_axp192
-m5_rtc
-m5_speaker
-```
+Please refer to [examples](examples/) and [API documentation](https://pguyot.github.io/atomvm_m5/).

examples/basic/how_to_use/.gitignore

@@ -0,0 +1,19 @@
+.rebar3
+_*
+.eunit
+*.o
+*.beam
+*.plt
+*.swp
+*.swo
+.erlang.cookie
+ebin
+log
+erl_crash.dump
+.rebar
+logs
+_build
+.idea
+*.iml
+rebar3.crashdump
+*~

examples/basic/how_to_use/README.md

@@ -0,0 +1,19 @@
+How to use
+==========
+
+![Sample code running on M5 Stick C Plus and M5GO](./how_to_use.jpg)
+
+This sample code is a port of the following example:
+https://github.com/m5stack/M5Unified/blob/master/examples/Basic/HowToUse/HowToUse.ino
+
+Installation
+------------
+
+- Compile and install AtomVM with `atomvm_m5` as explained [here](../../../README.md)
+- Install rebar3
+- Connect a M5 device with AtomVM (VM and library) preinstalled.
+- Compile and flash with:
+
+```
+rebar3 esp32_flash -p /dev/tty.usbserial-*
+```

examples/basic/how_to_use/rebar.config

@@ -0,0 +1,8 @@
+{erl_opts, [debug_info]}.
+{deps, [
+    {atomvm_m5, {path, "../../../"}}
+]}.
+{plugins, [
+    rebar3_path_deps,
+    {atomvm_rebar3_plugin, {git, "https://github.com/atomvm/atomvm_rebar3_plugin.git", {branch, "master"}}}
+]}.

examples/basic/how_to_use/src/how_to_use.app.src

@@ -0,0 +1,14 @@
+{application, how_to_use,
+ [{description, "How to use M5 sample code"},
+  {vsn, "0.1.0"},
+  {registered, []},
+  {applications,
+   [kernel,
+    stdlib
+   ]},
+  {env,[]},
+  {modules, []},
+
+  {licenses, ["MIT"]},
+  {links, []}
+ ]}.