@cella-lang/arduino 0.0.0-stage → 0.1.202610300802

package/CHANGES.md

@@ -0,0 +1,12 @@
+# @cella-lang/arduino 的變更
+
+給使用這個套件的工具看的 API 變更。
+
+## 未發佈
+
+- 第一版：Arduino、ESP32、ESP8266 上的 C++17（八種板子，`arduino` 是 `uno` 的別名）。板子決定資料模型（Uno 的 `int` 是 16 位元、ESP32 是 32 位元），core 與函式庫
+  （AVR core、arduino-esp32 3.0.7、esp8266/Arduino 3.1.2 的 Servo、DHT、LiquidCrystal、LiquidCrystal_I2C、EEPROM、WiFi）照它們的
+  C++ 原始碼建模，經 simavr 差分。入口：`arduino.verdict`、`arduino.types`、`arduino.boardInfo`、`arduino.withInputs` 與除錯器
+  （`load`、`run`、`stopKind`…、`env`、`setInput`、`clockMs`、`report`）。宿主隨時間給的輸入是程式 JSON 的 `"inputs"`，與 `"board"` 並列。
+  判決多帶 `pins`、`pinsTruncated`、`env`。
+- 板子沒有的函式庫（別的板子才有的標頭檔，例如 Uno 上的 `WiFi.h`）在 `#include` 的節點拒絕，理由是「`<WiFi.h>` is not a library of the board uno」，和編譯器停在同一行（之前到用到它的地方才以「use of undeclared identifier」拒絕）。

package/LICENSE

@@ -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.

package/NOTICE

@@ -0,0 +1,7 @@
+Cella
+Copyright 2026 SungYu Chang
+
+This product includes software developed by SungYu Chang
+(the Cella proof language: checker, standard library, and playground).
+
+Licensed under the Apache License, Version 2.0 (see LICENSE).

package/README.md

@@ -1,3 +1,87 @@
-# Temporary Holding Version
+# @cella-lang/arduino
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Arduino, ESP32 and ESP8266 for the [Cella](https://www.npmjs.com/package/cella-lang) proof checker, as a compiled module
+pack: C++17 on a board. The board is the program's environment: it decides the data model (the same `int` is 16 bits
+on an Uno and 32 bits on an ESP32), and its core and libraries are modeled from their C++ sources.
+
+Depends on `@cella-lang/cpp`, `@cella-lang/cfamily` and `@cella-lang/machine`.
+
+## Programs
+
+The JSON of `@cella-lang/cfamily`'s syntax with `"lang": {"k": "langCpp"}` and a board: `{"k": "prog", …, "board": "uno"}`.
+
+| Boards | `int` | `double` |
+|---|---|---|
+| `uno` (also `arduino`), `nano` | 16 bits | 32 bits |
+| `esp32`, `esp32c3`, `esp32s3`, `esp32s3Cam`, `nodemcuEsp8266`, `wemosD1Mini` | 32 bits | 64 bits |
+
+An unknown board makes the verdict `invalid`. A program with `setup` and `loop` and no `main` runs like a sketch:
+`setup` once, then `loop` until 5 simulated seconds. A program that defines its own entry (`main` on the AVR boards,
+`app_main` on the ESP32) runs that instead of the core's.
+
+### The core and the libraries
+
+The core: pins, time, `map`, `tone` and `noTone`, `pulseIn`, the board's constants (`{"k": "eConst", "name":
+"LED_BUILTIN"}`), `Serial`, `Serial1`…, and `String`. As in a real sketch, a library's names come with its header
+(`{"k": "iInclude", "header": "Servo.h"}`): `EEPROM.h`, `Servo.h`, `DHT.h`, `LiquidCrystal.h`, `LiquidCrystal_I2C.h`,
+and on the ESP boards `WiFi.h` (`WiFi.localIP()` is an `IPAddress`, printed as `a.b.c.d`). Library objects are
+ordinary objects: declare them with `tClass` and call their methods with `eMCall`. The models follow the AVR core,
+arduino-esp32 3.0.7 and esp8266/Arduino 3.1.2. `arduino.boardInfo "uno"` lists what a sketch on a board can name: its
+constants, serial ports, global objects and library classes.
+
+### The environment's inputs
+
+The program's JSON may carry the environment's inputs over time beside `"board"`:
+
+```json
+"inputs": [{"t": 1500, "key": "analog:A0", "value": 100}]
+```
+
+`t` is in milliseconds; an input applies once the simulated clock reaches it, and one that names a device waits until
+the device is declared. The keys:
+
+| Key | Input |
+|---|---|
+| `analog:A0` | an analog pin's reading |
+| `digital:2` | a digital pin's level |
+| `echo:10` | the width of the pulse `pulseIn` reads on a pin, in microseconds (none given: no pulse) |
+| `touch:4` | what `touchRead` reads on a pin (the ESP32 boards with touch; none given: 75) |
+| `dht:<name>.temperature`, `dht:<name>.humidity` | a DHT sensor's readings (the sensor answers when both are given; with either missing it is unplugged) |
+| `wifi` | the status `WiFi.begin` ends with, as a `wl_status_t` (none given: `WL_CONNECTED`) |
+| `eeprom:<address>` | an EEPROM cell's content at power-on |
+
+Devices are named after the variable that declares them (`s`, `lcd`, an array's elements `arm[0]`, `arm[1]`), in the
+keys and in `env` alike; an object with no variable (a member, a temporary) is `dev<n>`. The inputs are the run's
+environment, not the program's syntax: only this package's entries read them, and a C or C++ program without a board
+that carries them is `invalid`.
+
+## Verdicts
+
+The verdict JSON of `@cella-lang/cfamily`, with what the hardware did:
+
+- `pins`: each change of a pin's value, `{t, pin, value}` (the PWM duty when set, else the level); at most 1000, and
+  `pinsTruncated` says when more were dropped;
+- `env`: the hardware at the end: the clock, the loops run, each pin's mode, level, PWM and tone, the servos, the
+  LCDs' rows and the EEPROM cells written.
+
+## Entries
+
+- `arduino.verdict src input fuel`: the verdict; `input` is what `Serial` reads. A verdict proved by the kernels:
+  `kernel_verdict_in("arduino", "arduino.verdict", …)` in `cella-lang`.
+- `arduino.types src candidates`: the type query (format in `@cella-lang/cfamily`).
+- `arduino.boardInfo name`: what a sketch on the board can name.
+- `arduino.withInputs src inputs`: the program's JSON with `inputs` as its `"inputs"`, for a host written in Cella (a
+  JavaScript host sets the field).
+- The debugger, for `cella-lang/dap`: `load` (applies the program's `"inputs"`), `run`, `stopConf`, `stopKind`,
+  `stopNode`, `stopOut`, `stopErr`, `stopDetail`, `divergences`, `feed`, `globals`, `frames`, `setVarErr`,
+  `setVarConf`, `env` (the hardware of a paused run, as the wiring panel shows it), `setInput key value` (an input
+  changed while paused), `clockMs` (the simulated clock); and `report input fuel session`, a whole run with all the
+  input given at once. `cella-lang/dap` records the inputs changed while debugging, and `inputScript()` gives them back
+  as the `"inputs"` a verdict replays.
+
+## Loading
+
+Load the packs into the `cella-lang` build named by `index.json` (`checkerHash`, `cbfVersion`; the `peerDependencies`
+pin it): the standard modules in `index.requires["cella-lang"].modules`, the packages in `index.requires.packages`
+(each the same way), then this package's modules in the order of `index.modules.arduino.deps`. `cella-lang`'s README
+(*Official packages*) has the code.