@pamoja/can 0.1.15

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Anthony Wiedman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,108 @@
+# @pamoja/can
+
+CAN 2.0 and CAN-FD frames with 11- and 29-bit identifiers, plus J1939 decode and compose. One capability of [pamoja](https://github.com/molexxxx/pamoja), one memory-safe Rust core with bindings for TypeScript, Python, and C#.
+
+[![API reference](https://raw.githubusercontent.com/molexxxx/pamoja/main/.github/badges/btn-api.svg)](https://pamoja.molex.cloud/docs/reference/node/modules/_pamoja_can.html)
+[![read the guide](https://raw.githubusercontent.com/molexxxx/pamoja/main/.github/badges/btn-guide.svg)](https://pamoja.molex.cloud/docs/guides/can.html)
+[![documentation](https://raw.githubusercontent.com/molexxxx/pamoja/main/.github/badges/btn-docs.svg)](https://pamoja.molex.cloud/docs/)
+
+## Install
+
+```sh
+npm install @pamoja/can
+```
+
+This pulls in `@pamoja/native`, the compiled engine. `npm install pamoja` is the whole framework in one package.
+
+## Example
+
+The test that runs in CI, spliced here as it ran.
+
+From [`bindings/node/guides/can.ts`](https://github.com/molexxxx/pamoja/blob/main/bindings/node/guides/can.ts):
+
+```typescript
+import {
+  NOT_AVAILABLE,
+  broadcastJ1939,
+  composeJ1939,
+  decodeJ1939,
+  fdFrame,
+  frame,
+  priority,
+  signals,
+  signalsFrom,
+} from '@pamoja/can'
+
+// The nodes on this bus, by the address each answers to, and the two parameter groups
+// in play. J1939 publishes both, so naming them is what makes the traffic readable.
+const ENGINE = 0
+const GATEWAY = 1
+const GEARBOX = 33
+const ENGINE_CONTROLLER_1 = 61_444 // carries engine speed
+const REQUEST = 59_904 // asks another node for a parameter group
+
+// Where engine speed sits inside that group, and the scale the standard fixes for it.
+// Naming both is what stops a sender and a receiver disagreeing about either.
+const ENGINE_SPEED_AT = 3
+const RPM_PER_BIT = 0.125
+
+// J1939 keeps its addressing inside the CAN identifier: a priority, the parameter
+// group, and the address of whatever sent it. A broadcast has no destination, so it is
+// its own constructor rather than a magic address a caller has to know.
+const speedId = broadcastJ1939(priority.control, ENGINE_CONTROLLER_1, ENGINE)
+const speed = decodeJ1939(speedId)!
+console.log(`broadcast pgn ${speed.pgn} at priority ${speed.priority}`)
+
+// A parameter group below the PDU1 limit is addressed rather than broadcast, so those
+// eight identifier bits carry a destination instead of extending the group number.
+const requestId = composeJ1939(priority.default, REQUEST, GATEWAY, GEARBOX)
+console.log(`request   pgn ${decodeJ1939(requestId)!.pgn} addressed to node ${GEARBOX}`)
+
+// Reading one back off the bus is the same thing in reverse, so a receiver never
+// unpacks 29 bits by hand.
+const heard = decodeJ1939(requestId)!
+console.log(`heard     from node ${heard.source} for node ${heard.destination}`)
+
+// The payload. Every signal starts marked not available, and this controller reports
+// only engine speed, so that is the only one it writes.
+const reported = signals()
+reported.setU16(ENGINE_SPEED_AT, 1000 / RPM_PER_BIT)
+const eec1 = frame(speedId, reported.bytes, true)
+
+// The receiving node reads the same offset back, so neither end slices the payload.
+const rpm = signalsFrom(eec1.data).u16(ENGINE_SPEED_AT)! * RPM_PER_BIT
+console.log(`engine    ${rpm} rpm, carried in ${eec1.dlc} bytes`)
+
+// Above eight bytes CAN-FD encodes the length in steps rather than exactly, and a
+// classic frame still refuses a ninth byte.
+console.log(`32 bytes carries length code ${fdFrame(speedId, new Uint8Array(32), true).dlc}`)
+try {
+  frame(speedId, new Uint8Array(9), true)
+  console.log('a classic frame took nine bytes, which should never happen')
+} catch (error) {
+  console.log(`classic   refused nine bytes: ${(error as Error).message}`)
+}
+
+// J1939 never rides an 11-bit identifier, so a standard frame is not one of its
+// messages however its bits happen to line up.
+console.log(`an 11-bit identifier is J1939: ${decodeJ1939(291, false) !== null}`)
+```
+
+## The same capability in every language
+
+| Language | Package | Reference |
+| --- | --- | --- |
+| Rust | [`pamoja-can`](https://crates.io/crates/pamoja-can) | [reference](https://pamoja.molex.cloud/docs/reference/rust/pamoja_can/index.html), [docs.rs](https://docs.rs/pamoja-can) |
+| TypeScript | [`@pamoja/can`](https://www.npmjs.com/package/@pamoja/can) | [reference](https://pamoja.molex.cloud/docs/reference/node/modules/_pamoja_can.html) |
+| Python | [`pamoja-can`](https://pypi.org/project/pamoja-can/) | [reference](https://pamoja.molex.cloud/docs/reference/python/pamoja/can.html) |
+| C# | [`Pamoja.Can`](https://www.nuget.org/packages/Pamoja.Can) | [reference](https://pamoja.molex.cloud/docs/reference/dotnet/api/Pamoja.Can.html) |
+
+## Documentation
+
+- [`@pamoja/can` reference](https://pamoja.molex.cloud/docs/reference/node/modules/_pamoja_can.html), every class, function, and type this package exports.
+- [The CAN and J1939 guide](https://pamoja.molex.cloud/docs/guides/can.html), with the same example in Rust, Python, and C#.
+- [Every capability](https://pamoja.molex.cloud/docs/), and the [install page](https://pamoja.molex.cloud/docs/install.html).
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@pamoja/can",
+  "version": "0.1.15",
+  "description": "CAN 2.0 and CAN-FD frames with 11- and 29-bit identifiers, plus J1939 decode and compose.",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/molexxxx/pamoja.git",
+    "directory": "bindings/node/packages/can"
+  },
+  "homepage": "https://pamoja.molex.cloud/docs/guides/can.html",
+  "keywords": [
+    "pamoja",
+    "iot",
+    "robotics",
+    "can"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "LICENSE-MIT"
+  ],
+  "engines": {
+    "node": ">= 16"
+  },
+  "dependencies": {
+    "@pamoja/native": "0.1.15"
+  }
+}