npm - p5-phone - Versions diffs - 1.8.0 → 1.9.1 - Mend

p5-phone 1.8.0 → 1.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (92) hide show

package/README.md CHANGED Viewed

@@ -58,6 +58,7 @@ p5-phone supports both **p5.js 1.x** and **p5.js 2.0+**.
 | Microphone / Speech / Sound | ✅ | ✅ |
 | Camera (PhoneCamera) | ✅ | ✅ |
 | Vibration | ✅ | ✅ |
+| NFC Tag Reading (Android only) | ✅ | ✅ |
 | Debug console | ✅ | ✅ |
 | lockGestures() | ✅ | ✅ |
 | `touchStarted()` / `touchEnded()` | ✅ | ❌ Use `mousePressed()` / `mouseReleased()` |
@@ -86,6 +87,7 @@ p5-phone automatically detects the p5.js version and adjusts its internal touch
   - [Speech Recognition Activation](#speech-recognition-activation)
   - [Combined Activation](#combined-activation)
   - [Vibration Motor (Android Only)](#vibration-motor-android-only)
+  - [NFC Tag Reading (Android Only)](#nfc-tag-reading-android-only)
   - [PhoneCamera (ML5 Integration)](#phonecamera-ml5-integration)
   - [Debug System](#debug-system)
 - [Permission UI Styles](#permission-ui-styles)
@@ -100,10 +102,10 @@ p5-phone automatically detects the p5.js version and adjusts its internal touch
 ```html
 <!-- Minified version (recommended) -->
-<script src="https://cdn.jsdelivr.net/npm/p5-phone@1.8.0/dist/p5-phone.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/p5-phone@1.9.1/dist/p5-phone.min.js"></script>
 <!-- Development version (larger, with comments) -->
-<!-- <script src="https://cdn.jsdelivr.net/npm/p5-phone@1.8.0/dist/p5-phone.js"></script> -->
+<!-- <script src="https://cdn.jsdelivr.net/npm/p5-phone@1.9.1/dist/p5-phone.js"></script> -->
 ```
 ### Basic Setup
@@ -132,7 +134,7 @@ p5-phone automatically detects the p5.js version and adjusts its internal touch
   <!-- For p5.js 2.0: <script src="https://cdn.jsdelivr.net/npm/p5@2/lib/p5.min.js"></script> -->
   <!-- Load p5-phone library -->
-  <script src="https://cdn.jsdelivr.net/npm/p5-phone@1.8.0/dist/p5-phone.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/p5-phone@1.9.1/dist/p5-phone.min.js"></script>
 </head>
 <body>
@@ -302,6 +304,9 @@ this.enableGyroTap('Tap to start');
 - `window.soundEnabled` - Boolean indicating if sound output is active
 - `window.speechEnabled` - Boolean indicating if speech recognition is active
 - `window.vibrationEnabled` - Boolean indicating if vibration is available (Android only)
+- `window.nfcEnabled` - Boolean indicating if NFC scanning is active (Android only)
+- `window.lastNfcSerialNumber` - Serial number string for the most recently read NFC tag
+- `window.lastNfcAlias` - Alias string for the most recently read NFC tag, if one has been set
 **Usage:**
 ```javascript
@@ -326,14 +331,18 @@ function draw() {
     // Safe to use vibration (Android only)
     vibrate(50);
   }
+  if (window.nfcEnabled) {
+    // NFC scanning is active (Android only)
+    // Tag data arrives via nfcRead() callback
+  }
 }
 // You can also use them for conditional UI
-function setup() {
-  enableGyroTap('Tap to enable motion');
-  // Show different instructions based on status
-  if (!window.sensorsEnabled) {
+function draw() {
+  if (window.sensorsEnabled) {
+    debug("Motion sensors enabled");
+  } else {
     debug("Motion sensors not yet enabled");
   }
 }
@@ -638,6 +647,126 @@ function gameOver() {
 - Don't overuse - vibration can quickly drain battery
 - Test on Android devices as iOS doesn't support vibration
+### NFC Tag Reading (Android Only)
+**Purpose:** Read NFC (Near Field Communication) tags using the Web NFC API. Ideal for interactive installations, scavenger hunts, or any sketch that responds to physical NFC tags.
+**⚠️ Platform Support:**
+- ✅ **Android** - Chrome 89+ and Samsung Internet 15+
+- ❌ **iOS** - Not supported (Web NFC API not available on iOS)
+- Requires **HTTPS** — NFC is blocked on insecure origins
+**Important:** The Web NFC API requires user activation (a tap or click) before scanning can begin — the same pattern used by all other p5-phone permission functions. On unsupported devices/browsers, `window.nfcEnabled` will be `false` and calls will be safely ignored with console warnings.
+**Commands:**
+- `enableNfcTap(message)` - Tap anywhere on screen to enable NFC scanning
+- `enableNfcButton(text)` - Creates a button with custom text to enable NFC
+- `stopNfc()` - Stop NFC scanning
+- `setNfcTagAlias(serialNumber, alias)` - Give a tag ID a human-friendly name
+- `getNfcTagAlias(serialNumber)` - Get a saved alias for a tag ID
+- `isNfcTag(aliasOrSerialNumber)` - Check whether the most recently read tag matches an alias or ID
+**Status Variables:**
+- `window.nfcEnabled` - Boolean indicating if NFC scanning is active
+- `window.nfcStatus` - String describing NFC startup/read status
+- `window.nfcError` - String containing the latest NFC startup/read error
+- `window.nfcTagAliases` - Object mapping tag IDs to aliases
+- `window.lastNfcMessage` - Object containing the most recently read tag's data
+- `window.lastNfcSerialNumber` - Serial number string of the most recently read tag
+- `window.lastNfcAlias` - Alias string for the most recently read tag, if one has been set
+**Two-step workflow:**
+1. Open the NFC identifier example, scan each physical tag, type an alias, then download the tag list.
+2. Paste the generated `setNfcTagAlias()` lines into your sketch and use `isNfcTag()` in conditionals.
+**User Callback:**
+Define an `nfcRead()` function in your sketch to receive tag data when a tag is scanned:
+```javascript
+function nfcRead(message, serialNumber) {
+  // message.serialNumber — tag serial number
+  // message.alias — saved alias, or '' if unnamed
+  // message.records — array of NDEF records, each with:
+  //   .recordType — 'text', 'url', 'mime', etc.
+  //   .data — decoded content (string for text/url, object for JSON, raw for others)
+  //   .mediaType — MIME type (for 'mime' records)
+  //   .id — record id (if present)
+  //   .raw — original DataView
+}
+```
+**Usage:**
+```javascript
+let tagText = 'No tag scanned yet';
+function setup() {
+  createCanvas(windowWidth, windowHeight);
+  lockGestures();
+  // Paste IDs from the NFC identifier example.
+  setNfcTagAlias('04:85:2a:1b:9f:61:80', 'paintbrush');
+  setNfcTagAlias('04:42:18:3c:9f:61:80', 'desk');
+  enableNfcTap('Tap to enable NFC');
+}
+function draw() {
+  background(220);
+  textAlign(CENTER, CENTER);
+  textSize(20);
+  if (window.nfcEnabled) {
+    if (isNfcTag('paintbrush')) {
+      background(120, 220, 160);
+      text('Paintbrush tag read', width / 2, height / 2);
+    } else if (isNfcTag('desk')) {
+      background(140, 180, 240);
+      text('Desk tag read', width / 2, height / 2);
+    } else {
+      text(tagText, width / 2, height / 2);
+      text('Hold an NFC tag near your phone', width / 2, height / 2 + 40);
+    }
+  } else {
+    text('NFC not active', width / 2, height / 2);
+  }
+}
+function nfcRead(message, serialNumber) {
+  tagText = 'Tag: ' + (message.alias || serialNumber);
+  if (isNfcTag('paintbrush', serialNumber)) {
+    // This runs once when the paintbrush tag is scanned.
+  }
+  for (let record of message.records) {
+    if (record.recordType === 'text' || record.recordType === 'url') {
+      tagText += '\n' + record.data;
+    }
+  }
+}
+```
+**Record Types:**
+NFC tags contain NDEF records. The most common types are:
+| Record Type | `record.data` Contains | Example |
+|-------------|----------------------|----------|
+| `text` | Decoded string | `"Hello World"` |
+| `url` | Decoded URL string | `"https://example.com"` |
+| `mime` | Decoded string or parsed JSON | `{ id: 42 }` |
+| other | Raw `DataView` | Binary data |
+**Best Practices:**
+- Always check `window.nfcEnabled` before relying on NFC features
+- Use the `nfcRead()` callback for real-time tag processing
+- Use `setNfcTagAlias()` and `isNfcTag()` when a sketch should respond to named physical objects
+- Use `window.lastNfcMessage` in `draw()` for displaying the most recent tag
+- Test on Android devices with Chrome — NFC is not available on iOS or desktop browsers
+- Tags must be NDEF-formatted to be read by the Web NFC API
 ### Speech Recognition Activation
 **Purpose:** Enable the Web Speech API for voice input and speech-to-text in mobile browsers.
@@ -714,10 +843,10 @@ function draw() {
 ### PhoneCamera (ML5 Integration)
-**Purpose:** Simplified camera access optimized for ML5.js machine learning models (FaceMesh, HandPose, BodyPose, etc.). Handles camera initialization, coordinate mapping, mirroring, and display modes automatically.
+**Purpose:** Simplified camera access optimized for ML5.js machine learning models (FaceMesh, HandPose, BodyPose, ObjectDetection, etc.). Handles camera initialization, coordinate mapping, mirroring, and display modes automatically.
 **Key Features:**
-- **Automatic Coordinate Mapping** - ML5 keypoints automatically mapped to canvas coordinates
+- **Automatic Coordinate Mapping** - ML5 keypoints and bounding boxes automatically mapped to canvas coordinates
 - **Mirror Support** - Handles front camera mirroring for natural interaction
 - **Display Modes** - Multiple video sizing options (fitHeight, cover, contain, fixed)
 - **ML5 Optimized** - Direct integration with ML5 v1.x models
@@ -732,6 +861,8 @@ function draw() {
 | `cam.onReady(callback)` | Execute code when camera ready | Callback function |
 | `cam.mapKeypoint(keypoint)` | Map single ML5 keypoint to screen | ML5 keypoint object |
 | `cam.mapKeypoints(keypoints)` | Map array of ML5 keypoints | Array of ML5 keypoints |
+| `cam.mapBox(box)` | Map single ML5 bounding box to screen | ML5 detection object with x, y, width, height |
+| `cam.mapBoxes(boxes)` | Map array of ML5 bounding boxes | Array of ML5 detection objects |
 **Properties:**
@@ -765,7 +896,7 @@ function setup() {
     let options = {
       maxFaces: 1,
       refineLandmarks: false,
-      flipHorizontal: false  // cam.mapKeypoint() handles mirroring
+      flipped: false  // cam.mapKeypoint() handles mirroring
     };
     facemesh = ml5.faceMesh(options, modelLoaded);
@@ -818,7 +949,7 @@ function draw() {
 **Coordinate Mapping:**
-The `mapKeypoint()` and `mapKeypoints()` functions automatically handle:
+The `mapKeypoint()`, `mapKeypoints()`, `mapBox()`, and `mapBoxes()` functions automatically handle:
 - Video-to-canvas scaling
 - Mirror transformation (for front camera)
 - Offset positioning (for different display modes)
@@ -834,26 +965,34 @@ let hands = cam.mapKeypoints(hand.keypoints);
 hands.forEach(point => {
   circle(point.x, point.y, 5);
 });
+// Object detection bounding box
+let mappedObject = cam.mapBox(detection);
+rect(mappedObject.x, mappedObject.y, mappedObject.width, mappedObject.height);
 ```
 **ML5 Model Examples:**
 ```javascript
 // FaceMesh (468 keypoints)
-let options = { maxFaces: 1, refineLandmarks: false, flipHorizontal: false };
+let options = { maxFaces: 1, refineLandmarks: false, flipped: false };
 facemesh = ml5.faceMesh(options, modelLoaded);
 // HandPose (21 keypoints per hand)
-let options = { maxHands: 2, runtime: 'mediapipe', flipHorizontal: false };
+let options = { maxHands: 2, runtime: 'mediapipe', flipped: false };
 handpose = ml5.handPose(options, modelLoaded);
 // BodyPose (33 keypoints with 3D)
 let options = { modelType: 'MULTIPOSE_LIGHTNING', flipped: false };
 bodypose = ml5.bodyPose('BlazePose', options, modelLoaded);
+// ObjectDetection (bounding boxes)
+objectDetector = await ml5.objectDetection('cocossd');
+objectDetector.detectStart(cam.videoElement, gotDetections);
 ```
 **Important Notes:**
-- Always set `flipHorizontal: false` in ML5 options (PhoneCamera handles mirroring)
+- Always set `flipped: false` in ML5 options when available (PhoneCamera handles mirroring)
 - Use `cam.videoElement` (native HTML video element) when passing to ML5's `detectStart()`
 - Check `cam.ready` before using video or drawing keypoints
 - Call `enableCameraTap()` to handle camera permissions automatically
@@ -924,6 +1063,7 @@ The canvas displays a centered message until the user taps. Great for "full-scre
 - `enableSensorCanvas(message)`
 - `enableMicCanvas(message)`
 - `enableSpeechCanvas(message)`
+- `enableNfcCanvas(message)`
 - `enableAllCanvas(message)`
 - `enableCameraCanvas(message)`
@@ -936,9 +1076,11 @@ function setup() {
 }
 function draw() {
-  if (!window.sensorsEnabled) return;
   background(220);
-  circle(width/2 + rotationY * 3, height/2 + rotationX * 3, 50);
+  if (window.sensorsEnabled) {
+    circle(width/2 + rotationY * 3, height/2 + rotationX * 3, 50);
+  }
 }
 ```
@@ -950,6 +1092,7 @@ A styled banner slides in from the top of the screen with an animated entrance.
 - `enableSensorBanner(message)`
 - `enableMicBanner(message)`
 - `enableSpeechBanner(message)`
+- `enableNfcBanner(message)`
 - `enableAllBanner(message)`
 - `enableCameraBanner(message)`
@@ -977,6 +1120,7 @@ Bind the permission activation to any existing HTML element on the page using a
 - `enableSensorOn(selector)`
 - `enableMicOn(selector)`
 - `enableSpeechOn(selector)`
+- `enableNfcOn(selector)`
 - `enableAllOn(selector)`
 - `enableCameraOn(selector)`
@@ -996,9 +1140,11 @@ function setup() {
 }
 function draw() {
-  if (!window.sensorsEnabled) return;
   background(220);
-  circle(width/2 + rotationY * 3, height/2 + rotationX * 3, 50);
+  if (window.sensorsEnabled) {
+    circle(width/2 + rotationY * 3, height/2 + rotationX * 3, 50);
+  }
 }
 ```