From 8cf0ac98ebc4e2a4d972fad89b33692c38ef0ff2 Mon Sep 17 00:00:00 2001 From: tomashco Date: Fri, 14 Feb 2025 18:46:08 +0100 Subject: [PATCH 1/5] feat: addition of the APIRequest example in Elixir folder --- elixir/APIRequest/.formatter.exs | 4 + elixir/APIRequest/.gitignore | 6 ++ elixir/APIRequest/README.md | 9 ++ elixir/APIRequest/lib/APIRequest.ex | 151 ++++++++++++++++++++++++++++ elixir/APIRequest/mix.exs | 31 ++++++ elixir/Blinky/mix.exs | 2 +- elixir/HelloWorld/mix.exs | 2 +- 7 files changed, 203 insertions(+), 2 deletions(-) create mode 100644 elixir/APIRequest/.formatter.exs create mode 100644 elixir/APIRequest/.gitignore create mode 100644 elixir/APIRequest/README.md create mode 100644 elixir/APIRequest/lib/APIRequest.ex create mode 100644 elixir/APIRequest/mix.exs diff --git a/elixir/APIRequest/.formatter.exs b/elixir/APIRequest/.formatter.exs new file mode 100644 index 0000000..d2cda26 --- /dev/null +++ b/elixir/APIRequest/.formatter.exs @@ -0,0 +1,4 @@ +# Used by "mix format" +[ + inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"] +] diff --git a/elixir/APIRequest/.gitignore b/elixir/APIRequest/.gitignore new file mode 100644 index 0000000..1dfd2ed --- /dev/null +++ b/elixir/APIRequest/.gitignore @@ -0,0 +1,6 @@ +_build/* +_checkouts/* +src/config.erl +rebar.lock +*.avm +**.beam diff --git a/elixir/APIRequest/README.md b/elixir/APIRequest/README.md new file mode 100644 index 0000000..5089b10 --- /dev/null +++ b/elixir/APIRequest/README.md @@ -0,0 +1,9 @@ +# `APIRequest` Application + +Welcome to the `APIRequest` AtomVM application. + +The `APIRequest` AtomVM application connects to a wifi, and when the connection is established retrieves and prints on console a GET request over https. + +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 Elixir AtomVM example programs, see the Elixir example program [README](../README.md). diff --git a/elixir/APIRequest/lib/APIRequest.ex b/elixir/APIRequest/lib/APIRequest.ex new file mode 100644 index 0000000..eabcb1f --- /dev/null +++ b/elixir/APIRequest/lib/APIRequest.ex @@ -0,0 +1,151 @@ +# +# This file is part of AtomVM. +# +# Copyright 2018 Davide Bettio +# +# 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. +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later +# + +defmodule APIRequest do + def start() do + :io.format(~c"starting API Request application~n") + spawn(fn -> start_network() end) + + case wait_for_network() do + :ok -> + :io.format(~c"Connected to WiFi! Making HTTP request...~n") + + {:error, reason} -> + :io.format(~c"Failed to connect to WiFi: ~p~n", [reason]) + end + end + + defp start_network() do + :io.format(~c"Starting network...~n") + + config = [ + sta: [ + connected: fn -> + :io.format(~c"WiFi connected~n") + spawn(fn -> make_request() end) + end, + got_ip: fn info -> :io.format(~c"Got IP: ~p~n", [info]) end, + disconnected: fn -> :io.format(~c"WiFi disconnected~n") end, + # Edit these values for your network: + ssid: ~c"SSID_NAME", + psk: ~c"SSID_PASSWORD" + ] + ] + + case verify_platform(:atomvm.platform()) do + :ok -> + :io.format(~c"Starting network...~n") + + case :network.start(config) do + {:ok, _pid} -> + :io.format(~c"Network started.~n") + # Keep the network process alive + Process.sleep(:infinity) + + error -> + error + end + + error -> + error + end + end + + defp verify_platform(:esp32), do: :ok + defp verify_platform(platform), do: {:error, {:unsupported_platform, platform}} + + defp wait_for_network() do + :io.format(~c"Waiting for network...~n") + + receive do + {:network, :got_ip, _info} -> :ok + after + 30_000 -> {:error, :timeout} + end + end + + defp make_request() do + :io.format(~c"Making HTTPS request to api.sunrisesunset.io API...~n") + + ssl_opts = [{:active, false}, {:verify, :verify_none}] + ok = :ssl.start() + + case :ahttp_client.connect(:https, ~c"api.sunrisesunset.io", 443, ssl_opts) do + {:ok, conn} -> + case :ahttp_client.request(conn, ~c"GET", ~c"/json?lat=38.907192&lng=-77.036873", [], nil) do + {:ok, conn, ref} -> + :io.format(~c"Connection established, receiving response~n") + receive_response(conn, ref, []) + + error -> + :io.format(~c"Request failed: ~p~n", [error]) + end + + error -> + :io.format(~c"Connection failed: ~p~n", [error]) + end + + ok = :ssl.stop() + end + + defp receive_response(conn, ref, acc) do + case :ahttp_client.recv(conn, 0) do + {:ok, conn, responses} -> + process_responses(conn, ref, responses, acc) + + error -> + :io.format(~c"Receive failed: ~p~n", [error]) + end + end + + defp process_responses(conn, ref, [], acc) do + :ahttp_client.close(conn) + + case acc do + [data | _] -> + :io.format(~c"Data: ~p~n", [data]) + + _ -> + :ok + end + end + + defp process_responses(conn, ref, [{:status, ref, status} | rest], acc) do + :io.format(~c"Status: ~p~n", [status]) + process_responses(conn, ref, rest, acc) + end + + defp process_responses(conn, ref, [{:header, ref, {name, value}} | rest], acc) do + :io.format(~c"Header: ~s: ~s~n", [name, value]) + process_responses(conn, ref, rest, acc) + end + + defp process_responses(conn, ref, [{:data, ref, data} | rest], acc) do + process_responses(conn, ref, rest, [data | acc]) + end + + defp process_responses(conn, ref, [{:done, ref} | rest], acc) do + process_responses(conn, ref, rest, acc) + end + + defp process_responses(conn, ref, [_response | rest], acc) do + process_responses(conn, ref, rest, acc) + end +end diff --git a/elixir/APIRequest/mix.exs b/elixir/APIRequest/mix.exs new file mode 100644 index 0000000..2d4c708 --- /dev/null +++ b/elixir/APIRequest/mix.exs @@ -0,0 +1,31 @@ +defmodule APIRequest.MixProject do + use Mix.Project + + def project do + [ + app: :APIRequest, + version: "0.1.0", + elixir: "~> 1.13", + start_permanent: Mix.env() == :prod, + deps: deps(), + atomvm: [ + start: APIRequest, + flash_offset: 0x250000 + ] + ] + end + + # Run "mix help compile.app" to learn about applications. + def application do + [ + extra_applications: [:logger] + ] + end + + # Run "mix help deps" to learn about dependencies. + defp deps do + [ + {:exatomvm, git: "https://github.com/atomvm/ExAtomVM/"} + ] + end +end diff --git a/elixir/Blinky/mix.exs b/elixir/Blinky/mix.exs index eb468cd..bed3b42 100644 --- a/elixir/Blinky/mix.exs +++ b/elixir/Blinky/mix.exs @@ -10,7 +10,7 @@ defmodule Blinky.MixProject do deps: deps(), atomvm: [ start: Blinky, - flash_offset: 0x210000 + flash_offset: 0x250000 ] ] end diff --git a/elixir/HelloWorld/mix.exs b/elixir/HelloWorld/mix.exs index 7926ae7..0304f2a 100644 --- a/elixir/HelloWorld/mix.exs +++ b/elixir/HelloWorld/mix.exs @@ -10,7 +10,7 @@ defmodule HelloWorld.MixProject do deps: deps(), atomvm: [ start: HelloWorld, - flash_offset: 0x210000 + flash_offset: 0x250000 ] ] end From c54122da8ba8ad0a836452cd7245ffa11c01323c Mon Sep 17 00:00:00 2001 From: Winford Date: Fri, 8 Mar 2024 19:09:58 -0800 Subject: [PATCH 2/5] Add missing license tags to files In order to use the `Reuse Compliance` workflow all files must contain an acceptable license tag. This add the necessary tags to all of the existing examples and demos so that we can implement the reuse compliance workflow for future contributions. Signed-off-by: Winford --- .gitignore | 4 ++++ README.md | 6 ++++++ demos/morse_server/README.md | 11 ++++++---- demos/morse_server/rebar.config | 20 +++++++++++++++++++ demos/morse_server/rebar.lock | 6 ++++++ demos/morse_server/src/morse_server.app.src | 20 +++++++++++++++++++ demos/supervised_discs/README.md | 6 ++++++ demos/supervised_discs/rebar.config | 6 ++++++ demos/supervised_discs/rebar.lock | 6 ++++++ .../src/supervised_discs.app.src | 20 +++++++++++++++++++ elixir/Blinky/.formatter.exs | 20 +++++++++++++++++++ elixir/Blinky/README.md | 6 ++++++ elixir/Blinky/mix.exs | 20 +++++++++++++++++++ elixir/HelloWorld/.formatter.exs | 20 +++++++++++++++++++ elixir/HelloWorld/.gitignore | 4 ++++ elixir/HelloWorld/README.md | 6 ++++++ elixir/HelloWorld/mix.exs | 20 +++++++++++++++++++ elixir/LEDC_Example/.gitignore | 4 ++++ elixir/LEDC_Example/README.md | 6 ++++++ elixir/LEDC_Example/lib/LEDC_Example.ex | 2 +- elixir/LEDC_Example/mix.exs | 20 +++++++++++++++++++ elixir/README.md | 5 +++++ erlang/README.md | 5 +++++ erlang/arepl_example/.gitignore | 4 ++++ erlang/arepl_example/README.md | 6 ++++++ erlang/blinky/.gitignore | 4 ++++ erlang/blinky/README.md | 6 ++++++ erlang/deep_sleep/.gitignore | 4 ++++ erlang/deep_sleep/README.md | 6 ++++++ erlang/esp_nvs/.gitignore | 4 ++++ erlang/esp_nvs/README.md | 6 ++++++ erlang/gpio_interrupt/.gitignore | 4 ++++ erlang/gpio_interrupt/README.md | 6 ++++++ erlang/hello_world/.gitignore | 4 ++++ erlang/hello_world/README.md | 6 ++++++ erlang/i2c_example/.gitignore | 4 ++++ erlang/i2c_example/README.md | 6 ++++++ erlang/ledc_example/.gitignore | 4 ++++ erlang/ledc_example/README.md | 6 ++++++ erlang/read_priv/.gitignore | 4 ++++ erlang/read_priv/README.md | 6 ++++++ .../read_priv/priv/favicon-32x32.png.license | 3 +++ erlang/spi_example/.gitignore | 4 ++++ erlang/spi_example/README.md | 6 ++++++ erlang/system_info/.gitignore | 4 ++++ erlang/system_info/README.md | 6 ++++++ erlang/tcp_client/.gitignore | 4 ++++ erlang/tcp_client/README.md | 6 ++++++ erlang/tcp_server/.gitignore | 4 ++++ erlang/tcp_server/README.md | 6 ++++++ erlang/uart_example/.gitignore | 4 ++++ erlang/uart_example/README.md | 6 ++++++ erlang/udp_client/.gitignore | 4 ++++ erlang/udp_client/README.md | 6 ++++++ erlang/udp_server/.gitignore | 4 ++++ erlang/udp_server/README.md | 6 ++++++ erlang/wifi/.gitignore | 4 ++++ erlang/wifi/README.md | 10 ++++++++-- 58 files changed, 413 insertions(+), 7 deletions(-) create mode 100644 erlang/read_priv/priv/favicon-32x32.png.license diff --git a/.gitignore b/.gitignore index b41fd71..ba5bc9f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2018-2024 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + **/_build/** **/deps/** **/mix.lock diff --git a/README.md b/README.md index 60cb72c..51a931c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ + + # AtomVM Example Programs Welcome to the AtomVM Example Programs repository! diff --git a/demos/morse_server/README.md b/demos/morse_server/README.md index f084abc..dfcb875 100644 --- a/demos/morse_server/README.md +++ b/demos/morse_server/README.md @@ -1,3 +1,9 @@ + + # `morse_server` Application Welcome to the `morse_server` AtomVM application. @@ -42,11 +48,8 @@ For more information about programming on the AtomVM platform, see the [AtomVM P | Platform | Supported | |----------------|-----------| | `esp32` | ✅ | +| `pico` | ❌ | | `stm32` | ❌ | | `generic_unix` | ❌ | For general information about building and executing Erlang AtomVM example programs, see the Erlang example program [README](../../erlang/README.md). - - - - diff --git a/demos/morse_server/rebar.config b/demos/morse_server/rebar.config index 6d0c9c6..f5af06a 100644 --- a/demos/morse_server/rebar.config +++ b/demos/morse_server/rebar.config @@ -1,3 +1,23 @@ +% +% This file is part of AtomVM. +% +% Copyright 2019-2020 Davide Bettio +% +% 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. +% +% SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later +% + {erl_opts, [debug_info]}. {deps, []}. {plugins, [ diff --git a/demos/morse_server/rebar.lock b/demos/morse_server/rebar.lock index 57afcca..90293b5 100644 --- a/demos/morse_server/rebar.lock +++ b/demos/morse_server/rebar.lock @@ -1 +1,7 @@ +% +% Copyright 2019-2020 Davide Bettio +% +% SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later +% + []. diff --git a/demos/morse_server/src/morse_server.app.src b/demos/morse_server/src/morse_server.app.src index d1bb992..0b75f9f 100644 --- a/demos/morse_server/src/morse_server.app.src +++ b/demos/morse_server/src/morse_server.app.src @@ -1,3 +1,23 @@ +% +% This file is part of AtomVM. +% +% Copyright 2019-2020 Davide Bettio +% +% 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. +% +% SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later +% + {application, morse_server, [ {description, "An OTP library"}, {vsn, "0.1.0"}, diff --git a/demos/supervised_discs/README.md b/demos/supervised_discs/README.md index 57796d2..357c55e 100644 --- a/demos/supervised_discs/README.md +++ b/demos/supervised_discs/README.md @@ -1,3 +1,9 @@ + + # `supervised_discs` Application Welcome to the `supervised_discs` AtomVM application. diff --git a/demos/supervised_discs/rebar.config b/demos/supervised_discs/rebar.config index 6040fbd..311eab5 100644 --- a/demos/supervised_discs/rebar.config +++ b/demos/supervised_discs/rebar.config @@ -1,3 +1,9 @@ +% +% Copyright 2023 Paul Guyot +% +% SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later +% + {erl_opts, [debug_info]}. {deps, [ {atomvm_lib, {git, "https://github.com/atomvm/atomvm_lib.git", {branch, "master"}}} diff --git a/demos/supervised_discs/rebar.lock b/demos/supervised_discs/rebar.lock index bf5e843..0bf39e5 100644 --- a/demos/supervised_discs/rebar.lock +++ b/demos/supervised_discs/rebar.lock @@ -1,3 +1,9 @@ +% +% Copyright 2023 Paul Guyot +% +% SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later +% + [{<<"atomvm_lib">>, {git,"https://github.com/atomvm/atomvm_lib.git", {ref,"34e056e3de94555d0a51d0a30234cd95ff7920d7"}}, diff --git a/demos/supervised_discs/src/supervised_discs.app.src b/demos/supervised_discs/src/supervised_discs.app.src index 02254c0..80fda7f 100644 --- a/demos/supervised_discs/src/supervised_discs.app.src +++ b/demos/supervised_discs/src/supervised_discs.app.src @@ -1,3 +1,23 @@ +% +% This file is part of AtomVM. +% +% Copyright 2023 Paul Guyot +% +% 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. +% +% SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later +% + {application, supervised_discs, [ {description, "Supervised discs"}, {vsn, "0.1.0"}, diff --git a/elixir/Blinky/.formatter.exs b/elixir/Blinky/.formatter.exs index d2cda26..73bb8ef 100644 --- a/elixir/Blinky/.formatter.exs +++ b/elixir/Blinky/.formatter.exs @@ -1,3 +1,23 @@ +# +# This file is part of AtomVM. +# +# Copyright 2018 Davide Bettio +# +# 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. +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later +# + # Used by "mix format" [ inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"] diff --git a/elixir/Blinky/README.md b/elixir/Blinky/README.md index 6ef9c6b..a571368 100644 --- a/elixir/Blinky/README.md +++ b/elixir/Blinky/README.md @@ -1,3 +1,9 @@ + + # `Blinky` Application Welcome to the `Blinky` AtomVM application. diff --git a/elixir/Blinky/mix.exs b/elixir/Blinky/mix.exs index bed3b42..87ae296 100644 --- a/elixir/Blinky/mix.exs +++ b/elixir/Blinky/mix.exs @@ -1,3 +1,23 @@ +# +# This file is part of AtomVM. +# +# Copyright 2018 Davide Bettio +# +# 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. +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later +# + defmodule Blinky.MixProject do use Mix.Project diff --git a/elixir/HelloWorld/.formatter.exs b/elixir/HelloWorld/.formatter.exs index d2cda26..73bb8ef 100644 --- a/elixir/HelloWorld/.formatter.exs +++ b/elixir/HelloWorld/.formatter.exs @@ -1,3 +1,23 @@ +# +# This file is part of AtomVM. +# +# Copyright 2018 Davide Bettio +# +# 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. +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later +# + # Used by "mix format" [ inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"] diff --git a/elixir/HelloWorld/.gitignore b/elixir/HelloWorld/.gitignore index 1dfd2ed..ffae2ed 100644 --- a/elixir/HelloWorld/.gitignore +++ b/elixir/HelloWorld/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/elixir/HelloWorld/README.md b/elixir/HelloWorld/README.md index 1df69bd..cf21b24 100644 --- a/elixir/HelloWorld/README.md +++ b/elixir/HelloWorld/README.md @@ -1,3 +1,9 @@ + + # `HelloWorld` Application Welcome to the `HelloWorld` AtomVM application. diff --git a/elixir/HelloWorld/mix.exs b/elixir/HelloWorld/mix.exs index 0304f2a..f518ef2 100644 --- a/elixir/HelloWorld/mix.exs +++ b/elixir/HelloWorld/mix.exs @@ -1,3 +1,23 @@ +# +# This file is part of AtomVM. +# +# Copyright 2018 Davide Bettio +# +# 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. +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later +# + defmodule HelloWorld.MixProject do use Mix.Project diff --git a/elixir/LEDC_Example/.gitignore b/elixir/LEDC_Example/.gitignore index 1340604..f8a63a4 100644 --- a/elixir/LEDC_Example/.gitignore +++ b/elixir/LEDC_Example/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Winford (Uncle Grumpy) +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + # The directory Mix will write compiled artifacts to. /_build/ diff --git a/elixir/LEDC_Example/README.md b/elixir/LEDC_Example/README.md index 9323238..7d46875 100644 --- a/elixir/LEDC_Example/README.md +++ b/elixir/LEDC_Example/README.md @@ -1,3 +1,9 @@ + + # `LEDC_Example` Application Welcome to the `LEDC_Example` AtomVM application. diff --git a/elixir/LEDC_Example/lib/LEDC_Example.ex b/elixir/LEDC_Example/lib/LEDC_Example.ex index 9988f4d..d859ea6 100644 --- a/elixir/LEDC_Example/lib/LEDC_Example.ex +++ b/elixir/LEDC_Example/lib/LEDC_Example.ex @@ -1,7 +1,7 @@ # # This file is part of AtomVM. # -# Copyright 2022 Winford (Uncle Grumpy) +# Copyright 2022 Winford (Uncle Grumpy) # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/elixir/LEDC_Example/mix.exs b/elixir/LEDC_Example/mix.exs index 856ac81..a45b327 100644 --- a/elixir/LEDC_Example/mix.exs +++ b/elixir/LEDC_Example/mix.exs @@ -1,3 +1,23 @@ +# +# This file is part of AtomVM. +# +# Copyright 2022 Winford (Uncle Grumpy) +# +# 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. +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later +# + defmodule LedcExample.MixProject do use Mix.Project diff --git a/elixir/README.md b/elixir/README.md index 1bde9e1..07acf74 100644 --- a/elixir/README.md +++ b/elixir/README.md @@ -1,3 +1,8 @@ + # AtomVM Elixir Example Programs diff --git a/erlang/README.md b/erlang/README.md index 4e3b568..bda008c 100644 --- a/erlang/README.md +++ b/erlang/README.md @@ -1,3 +1,8 @@ + # AtomVM Erlang Example Programs diff --git a/erlang/arepl_example/.gitignore b/erlang/arepl_example/.gitignore index d36cc29..add22d2 100644 --- a/erlang/arepl_example/.gitignore +++ b/erlang/arepl_example/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/arepl_example/README.md b/erlang/arepl_example/README.md index 52e70ae..241b85f 100644 --- a/erlang/arepl_example/README.md +++ b/erlang/arepl_example/README.md @@ -1,3 +1,9 @@ + + # `arepl_example` Application Welcome to the `arepl_example` AtomVM application. diff --git a/erlang/blinky/.gitignore b/erlang/blinky/.gitignore index d36cc29..add22d2 100644 --- a/erlang/blinky/.gitignore +++ b/erlang/blinky/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/blinky/README.md b/erlang/blinky/README.md index 9acb5ce..c53efe4 100644 --- a/erlang/blinky/README.md +++ b/erlang/blinky/README.md @@ -1,3 +1,9 @@ + + # `blinky` Application Welcome to the `blinky` AtomVM application. diff --git a/erlang/deep_sleep/.gitignore b/erlang/deep_sleep/.gitignore index d36cc29..add22d2 100644 --- a/erlang/deep_sleep/.gitignore +++ b/erlang/deep_sleep/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/deep_sleep/README.md b/erlang/deep_sleep/README.md index 77ddf30..b219d4a 100644 --- a/erlang/deep_sleep/README.md +++ b/erlang/deep_sleep/README.md @@ -1,3 +1,9 @@ + + # `deep_sleep` Application Welcome to the `deep_sleep` AtomVM application. diff --git a/erlang/esp_nvs/.gitignore b/erlang/esp_nvs/.gitignore index d36cc29..add22d2 100644 --- a/erlang/esp_nvs/.gitignore +++ b/erlang/esp_nvs/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/esp_nvs/README.md b/erlang/esp_nvs/README.md index 6bba0c4..0215e9e 100644 --- a/erlang/esp_nvs/README.md +++ b/erlang/esp_nvs/README.md @@ -1,3 +1,9 @@ + + # `esp_nvs` Application Welcome to the `esp_nvs` AtomVM application. diff --git a/erlang/gpio_interrupt/.gitignore b/erlang/gpio_interrupt/.gitignore index d36cc29..add22d2 100644 --- a/erlang/gpio_interrupt/.gitignore +++ b/erlang/gpio_interrupt/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/gpio_interrupt/README.md b/erlang/gpio_interrupt/README.md index 7dbee58..ecffda3 100644 --- a/erlang/gpio_interrupt/README.md +++ b/erlang/gpio_interrupt/README.md @@ -1,3 +1,9 @@ + + # `gpio_interrupt` Application Welcome to the `gpio_interrupt` AtomVM application. diff --git a/erlang/hello_world/.gitignore b/erlang/hello_world/.gitignore index d36cc29..add22d2 100644 --- a/erlang/hello_world/.gitignore +++ b/erlang/hello_world/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/hello_world/README.md b/erlang/hello_world/README.md index b18021e..858575e 100644 --- a/erlang/hello_world/README.md +++ b/erlang/hello_world/README.md @@ -1,3 +1,9 @@ + + # `hello_world` Application Welcome to the `hello_world` AtomVM application. diff --git a/erlang/i2c_example/.gitignore b/erlang/i2c_example/.gitignore index d36cc29..add22d2 100644 --- a/erlang/i2c_example/.gitignore +++ b/erlang/i2c_example/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/i2c_example/README.md b/erlang/i2c_example/README.md index d4b1128..2836e70 100644 --- a/erlang/i2c_example/README.md +++ b/erlang/i2c_example/README.md @@ -1,3 +1,9 @@ + + # `i2c_example` Application Welcome to the `i2c_example` AtomVM application. diff --git a/erlang/ledc_example/.gitignore b/erlang/ledc_example/.gitignore index d36cc29..add22d2 100644 --- a/erlang/ledc_example/.gitignore +++ b/erlang/ledc_example/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/ledc_example/README.md b/erlang/ledc_example/README.md index b4b61ef..21b4bc0 100644 --- a/erlang/ledc_example/README.md +++ b/erlang/ledc_example/README.md @@ -1,3 +1,9 @@ + + # `ledc_example` Application Welcome to the `ledc_example` AtomVM application. diff --git a/erlang/read_priv/.gitignore b/erlang/read_priv/.gitignore index d36cc29..add22d2 100644 --- a/erlang/read_priv/.gitignore +++ b/erlang/read_priv/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/read_priv/README.md b/erlang/read_priv/README.md index 35ef7fb..3b8adbe 100644 --- a/erlang/read_priv/README.md +++ b/erlang/read_priv/README.md @@ -1,3 +1,9 @@ + + # `read_priv` Application Welcome to the `read_priv` AtomVM application. diff --git a/erlang/read_priv/priv/favicon-32x32.png.license b/erlang/read_priv/priv/favicon-32x32.png.license new file mode 100644 index 0000000..997e062 --- /dev/null +++ b/erlang/read_priv/priv/favicon-32x32.png.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2022 Fred Dushin + +SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later diff --git a/erlang/spi_example/.gitignore b/erlang/spi_example/.gitignore index d36cc29..add22d2 100644 --- a/erlang/spi_example/.gitignore +++ b/erlang/spi_example/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/spi_example/README.md b/erlang/spi_example/README.md index a274162..032ac62 100644 --- a/erlang/spi_example/README.md +++ b/erlang/spi_example/README.md @@ -1,3 +1,9 @@ + + # `spi_example` Application Welcome to the `spi_example` AtomVM application. diff --git a/erlang/system_info/.gitignore b/erlang/system_info/.gitignore index d36cc29..add22d2 100644 --- a/erlang/system_info/.gitignore +++ b/erlang/system_info/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/system_info/README.md b/erlang/system_info/README.md index e404258..645f24d 100644 --- a/erlang/system_info/README.md +++ b/erlang/system_info/README.md @@ -1,3 +1,9 @@ + + # `system_info` Application Welcome to the `system_info` AtomVM application. diff --git a/erlang/tcp_client/.gitignore b/erlang/tcp_client/.gitignore index d36cc29..add22d2 100644 --- a/erlang/tcp_client/.gitignore +++ b/erlang/tcp_client/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/tcp_client/README.md b/erlang/tcp_client/README.md index 28e79ed..cabe014 100644 --- a/erlang/tcp_client/README.md +++ b/erlang/tcp_client/README.md @@ -1,3 +1,9 @@ + + # `tcp_client` Application Welcome to the `tcp_client` AtomVM application. diff --git a/erlang/tcp_server/.gitignore b/erlang/tcp_server/.gitignore index d36cc29..add22d2 100644 --- a/erlang/tcp_server/.gitignore +++ b/erlang/tcp_server/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/tcp_server/README.md b/erlang/tcp_server/README.md index 4848e74..cbd002d 100644 --- a/erlang/tcp_server/README.md +++ b/erlang/tcp_server/README.md @@ -1,3 +1,9 @@ + + # `tcp_server` Application Welcome to the `tcp_server` AtomVM application. diff --git a/erlang/uart_example/.gitignore b/erlang/uart_example/.gitignore index d36cc29..add22d2 100644 --- a/erlang/uart_example/.gitignore +++ b/erlang/uart_example/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/uart_example/README.md b/erlang/uart_example/README.md index 0e8d0eb..f94d306 100644 --- a/erlang/uart_example/README.md +++ b/erlang/uart_example/README.md @@ -1,3 +1,9 @@ + + # `uart_example` Application Welcome to the `uart_example` AtomVM application. diff --git a/erlang/udp_client/.gitignore b/erlang/udp_client/.gitignore index d36cc29..add22d2 100644 --- a/erlang/udp_client/.gitignore +++ b/erlang/udp_client/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/udp_client/README.md b/erlang/udp_client/README.md index d808ead..f98094b 100644 --- a/erlang/udp_client/README.md +++ b/erlang/udp_client/README.md @@ -1,3 +1,9 @@ + + # `udp_client` Application Welcome to the `udp_client` AtomVM application. diff --git a/erlang/udp_server/.gitignore b/erlang/udp_server/.gitignore index d36cc29..add22d2 100644 --- a/erlang/udp_server/.gitignore +++ b/erlang/udp_server/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/udp_server/README.md b/erlang/udp_server/README.md index f53d225..3c38d97 100644 --- a/erlang/udp_server/README.md +++ b/erlang/udp_server/README.md @@ -1,3 +1,9 @@ + + # `udp_server` Application Welcome to the `udp_server` AtomVM application. diff --git a/erlang/wifi/.gitignore b/erlang/wifi/.gitignore index d36cc29..add22d2 100644 --- a/erlang/wifi/.gitignore +++ b/erlang/wifi/.gitignore @@ -1,3 +1,7 @@ +# Copyright 2023 Fred Dushin +# +# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later + _build/* _checkouts/* src/config.erl diff --git a/erlang/wifi/README.md b/erlang/wifi/README.md index b9468dc..975ea46 100644 --- a/erlang/wifi/README.md +++ b/erlang/wifi/README.md @@ -1,3 +1,9 @@ + + # `wifi` Application Welcome to the `wifi` AtomVM application. @@ -11,6 +17,6 @@ For general information about building and executing Erlang AtomVM example progr > **IMPORTANT** If you are running this example program on a device that supports WiFi (e.g., the ESP32 or Pico W), you must first copy the `src/config.erl-template` file to set `src/config.erl` and edit the WiFi Access Point SSID and PSK to which the ESP32 device is to connect before building this application: sta => [ - {ssid, "my_sta_ssid"}, - {psk, "my_sta_psk"} + {ssid, <<"my_sta_ssid">>}, + {psk, <<"my_sta_psk">>} ] From d9b6aca238c8cf975f54e5051a69b45b4b54adb9 Mon Sep 17 00:00:00 2001 From: Winford Date: Sun, 3 Mar 2024 20:27:39 -0800 Subject: [PATCH 3/5] Add signoff check to CI Adds a copy of the reuse compliance check from AtomVM workflows, and adds coppies of licenses to `LICENSES` directory. Signed-off-by: Winford --- .github/workflows/reuse-lint.yaml | 19 ++ LICENSES/Apache-2.0.txt | 202 ++++++++++++ LICENSES/CC0-1.0.txt | 121 +++++++ LICENSES/LGPL-2.1-or-later.txt | 502 ++++++++++++++++++++++++++++++ 4 files changed, 844 insertions(+) create mode 100644 .github/workflows/reuse-lint.yaml create mode 100644 LICENSES/Apache-2.0.txt create mode 100644 LICENSES/CC0-1.0.txt create mode 100644 LICENSES/LGPL-2.1-or-later.txt diff --git a/.github/workflows/reuse-lint.yaml b/.github/workflows/reuse-lint.yaml new file mode 100644 index 0000000..9df27c3 --- /dev/null +++ b/.github/workflows/reuse-lint.yaml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2022 Free Software Foundation Europe e.V. +# +# SPDX-License-Identifier: CC0-1.0 + +name: REUSE Compliance Check + +on: [push, pull_request] + +concurrency: + group: ${{ github.workflow }}-${{ github.ref != 'refs/heads/main' && github.ref || github.run_id }} + cancel-in-progress: true + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: REUSE Compliance Check + uses: fsfe/reuse-action@v1 diff --git a/LICENSES/Apache-2.0.txt b/LICENSES/Apache-2.0.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSES/Apache-2.0.txt @@ -0,0 +1,202 @@ + + 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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/LICENSES/LGPL-2.1-or-later.txt b/LICENSES/LGPL-2.1-or-later.txt new file mode 100644 index 0000000..4362b49 --- /dev/null +++ b/LICENSES/LGPL-2.1-or-later.txt @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! From 2bedd34aa6215cc71fe7f987b9ee58f1d2b573c2 Mon Sep 17 00:00:00 2001 From: tomashco Date: Tue, 18 Feb 2025 22:10:26 +0100 Subject: [PATCH 4/5] chore: removed changes from other examples --- elixir/Blinky/mix.exs | 2 +- elixir/HelloWorld/mix.exs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/elixir/Blinky/mix.exs b/elixir/Blinky/mix.exs index 87ae296..aada868 100644 --- a/elixir/Blinky/mix.exs +++ b/elixir/Blinky/mix.exs @@ -30,7 +30,7 @@ defmodule Blinky.MixProject do deps: deps(), atomvm: [ start: Blinky, - flash_offset: 0x250000 + flash_offset: 0x210000 ] ] end diff --git a/elixir/HelloWorld/mix.exs b/elixir/HelloWorld/mix.exs index f518ef2..fed6a20 100644 --- a/elixir/HelloWorld/mix.exs +++ b/elixir/HelloWorld/mix.exs @@ -30,7 +30,7 @@ defmodule HelloWorld.MixProject do deps: deps(), atomvm: [ start: HelloWorld, - flash_offset: 0x250000 + flash_offset: 0x210000 ] ] end From 7fada32a8a4c536900aa3900e1aa5db5f4fa9f87 Mon Sep 17 00:00:00 2001 From: tomashco Date: Wed, 19 Feb 2025 00:07:48 +0100 Subject: [PATCH 5/5] chore: moved secrets to separate module under gitignore, changed :io.format to IO.puts. Getting crash --- elixir/APIRequest/.gitignore | 1 + elixir/APIRequest/lib/APIRequest.ex | 55 +++++++++++++---------- elixir/APIRequest/lib/Secrets.ex-template | 12 +++++ 3 files changed, 44 insertions(+), 24 deletions(-) create mode 100644 elixir/APIRequest/lib/Secrets.ex-template diff --git a/elixir/APIRequest/.gitignore b/elixir/APIRequest/.gitignore index 1dfd2ed..b929180 100644 --- a/elixir/APIRequest/.gitignore +++ b/elixir/APIRequest/.gitignore @@ -1,5 +1,6 @@ _build/* _checkouts/* +lib/Secrets.ex src/config.erl rebar.lock *.avm diff --git a/elixir/APIRequest/lib/APIRequest.ex b/elixir/APIRequest/lib/APIRequest.ex index eabcb1f..1610958 100644 --- a/elixir/APIRequest/lib/APIRequest.ex +++ b/elixir/APIRequest/lib/APIRequest.ex @@ -1,16 +1,16 @@ # # This file is part of AtomVM. # -# Copyright 2018 Davide Bettio +# Copyright 2025 Tommaso Maioli # -# Licensed under the Apache License, Version 2.0 (the "License"); +# 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, +# 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. @@ -19,43 +19,45 @@ # defmodule APIRequest do + import Secrets + def start() do - :io.format(~c"starting API Request application~n") + IO.puts("starting API Request application\n") spawn(fn -> start_network() end) case wait_for_network() do :ok -> - :io.format(~c"Connected to WiFi! Making HTTP request...~n") + IO.puts("Connected to WiFi! Making HTTP request...\n") {:error, reason} -> - :io.format(~c"Failed to connect to WiFi: ~p~n", [reason]) + IO.puts("Failed to connect to WiFi: #{reason}\n") end end defp start_network() do - :io.format(~c"Starting network...~n") + IO.puts("Starting network...\n") + wifi_cfg = get_secret(:wifi_cfg) config = [ sta: [ connected: fn -> - :io.format(~c"WiFi connected~n") + IO.puts("WiFi connected\n") spawn(fn -> make_request() end) end, - got_ip: fn info -> :io.format(~c"Got IP: ~p~n", [info]) end, - disconnected: fn -> :io.format(~c"WiFi disconnected~n") end, - # Edit these values for your network: - ssid: ~c"SSID_NAME", - psk: ~c"SSID_PASSWORD" + got_ip: fn info -> IO.puts("Got IP: #{info}\n") end, + disconnected: fn -> IO.puts("WiFi disconnected\n") end, + ssid: wifi_cfg[:ssid], + psk: wifi_cfg[:psk] ] ] case verify_platform(:atomvm.platform()) do :ok -> - :io.format(~c"Starting network...~n") + IO.puts("Starting network...\n") case :network.start(config) do {:ok, _pid} -> - :io.format(~c"Network started.~n") + IO.puts("Network started.\n") # Keep the network process alive Process.sleep(:infinity) @@ -72,7 +74,7 @@ defmodule APIRequest do defp verify_platform(platform), do: {:error, {:unsupported_platform, platform}} defp wait_for_network() do - :io.format(~c"Waiting for network...~n") + IO.puts("Waiting for network...\n") receive do {:network, :got_ip, _info} -> :ok @@ -82,24 +84,29 @@ defmodule APIRequest do end defp make_request() do - :io.format(~c"Making HTTPS request to api.sunrisesunset.io API...~n") + IO.puts("Making HTTPS request to api.sunrisesunset.io API...\n") ssl_opts = [{:active, false}, {:verify, :verify_none}] ok = :ssl.start() + IO.puts("TRYING CONN\n") case :ahttp_client.connect(:https, ~c"api.sunrisesunset.io", 443, ssl_opts) do {:ok, conn} -> + IO.puts("CONN OK\n") + case :ahttp_client.request(conn, ~c"GET", ~c"/json?lat=38.907192&lng=-77.036873", [], nil) do {:ok, conn, ref} -> - :io.format(~c"Connection established, receiving response~n") + IO.puts("REQ OK\n") + IO.puts("Connection established, receiving response\n") receive_response(conn, ref, []) error -> - :io.format(~c"Request failed: ~p~n", [error]) + IO.puts("Request failed: #{inspect(error)}\n") end error -> - :io.format(~c"Connection failed: ~p~n", [error]) + IO.puts("CONN FAILED\n") + IO.puts("Connection failed: #{inspect(error)}\n") end ok = :ssl.stop() @@ -111,7 +118,7 @@ defmodule APIRequest do process_responses(conn, ref, responses, acc) error -> - :io.format(~c"Receive failed: ~p~n", [error]) + IO.puts("Receive failed: #{inspect(error)}\n") end end @@ -120,7 +127,7 @@ defmodule APIRequest do case acc do [data | _] -> - :io.format(~c"Data: ~p~n", [data]) + IO.puts("Data: #{inspect(data)}\n") _ -> :ok @@ -128,12 +135,12 @@ defmodule APIRequest do end defp process_responses(conn, ref, [{:status, ref, status} | rest], acc) do - :io.format(~c"Status: ~p~n", [status]) + IO.puts("Status: #{status}\n") process_responses(conn, ref, rest, acc) end defp process_responses(conn, ref, [{:header, ref, {name, value}} | rest], acc) do - :io.format(~c"Header: ~s: ~s~n", [name, value]) + IO.puts("Header: #{name}: #{value}\n") process_responses(conn, ref, rest, acc) end diff --git a/elixir/APIRequest/lib/Secrets.ex-template b/elixir/APIRequest/lib/Secrets.ex-template new file mode 100644 index 0000000..1626ce7 --- /dev/null +++ b/elixir/APIRequest/lib/Secrets.ex-template @@ -0,0 +1,12 @@ +defmodule Secrets do + @secrets %{ + wifi_cfg: [ + ssid: "your_ssid_here", + psk: "your_psk_here" + ] + } + + def get_secret(key) do + Map.get(@secrets, key, :not_found) + end +end