@tempivo/sensor-beacon 0.1.0 → 0.1.1

package/README.md

@@ -1,18 +1,22 @@
 # @tempivo/sensor-beacon
 
-Decode **Tempivo sensor** BLE **manufacturer data** (company id **0x026C**). Use this in partner apps, gateways, or Node scripts that scan advertisements. **No GATT connection** is required.
+Tempivo partner SDK for **BLE advertising** from Tempivo sensors (manufacturer id **0x026C**). **No GATT connection.**
 
-## Install
+One npm package:
+
+| Path | Use |
+|------|-----|
+| `dist/` | Node / TypeScript decoder |
+| `android/` + `dist/tempivo-sensor-beacon.aar` | Android scan + decode |
+| `ios/` | iOS Swift Package (scan + decode) |
 
 ```bash
 npm install @tempivo/sensor-beacon
 ```
 
-Node.js 18+.
-
-## Quick start
+## Node / TypeScript
 
-Many platforms return manufacturer bytes **without** the 2-byte company id (`6C 02`). If your stack includes the id, strip it first:
+Node.js 18+. Import from the package root:
 
 ```ts
 import {
@@ -21,28 +25,14 @@ import {
   decodeSensorBeaconPayload,
 } from '@tempivo/sensor-beacon';
 
-// Web Bluetooth: manufacturerData.get(0x026C) → DataView
-const payload = normalizeManufacturerBytes(manufacturerDataView);
-const reading = decodeSensorBeaconPayload(payload);
-if (reading) {
-  console.log(reading.serialMac, reading.firmware, reading.temperatures);
-}
+const reading = decodeSensorBeaconPayload(normalizeManufacturerBytes(rawBytes));
 ```
 
-`TEMPVO_SENSOR_MANUFACTURER_ID` is `0x026c` (same id on air as little-endian `6C 02`).
-
-## Advertising-only workflow
+Many stacks return manufacturer bytes **without** the 2-byte company id (`6C 02`). Use `normalizeManufacturerBytes` when needed.
 
-1. Scan BLE advertisements (no connect).
-2. Read manufacturer specific data for **0x026C**.
-3. Call `normalizeManufacturerBytes` then `decodeSensorBeaconPayload`, or cache frames with `ingestManufacturerPayload` and merge with `buildSensorBeaconReading`.
+### Frame cache (`0x03` + `0x04`)
 
-FW6 devices split data across:
-
-- **`0x03` frame** (22 bytes): serial/MAC, firmware, battery, period, timestamp.
-- **`0x04` frame** (scan response): measurement slots (temperature, humidity, CO₂, etc.).
-
-You may receive `0x03` and `0x04` in separate packets. Use `SensorBeaconFrameCache` to merge by device key:
+FW6 devices split meta (advertisement) and measurements (scan response):
 
 ```ts
 import {
@@ -54,34 +44,87 @@ import {
 
 const cache = createSensorBeaconFrameCache();
 const macKey = macKeyFromAddress('28:2C:02:4F:00:12');
-
 ingestManufacturerPayload(advPayload, macKey, cache);
 ingestManufacturerPayload(scanPayload, macKey, cache);
-
-const reading = buildSensorBeaconReading(
-  cache.last03.get(macKey),
-  cache.last04.get(macKey)
-);
+const reading = buildSensorBeaconReading(cache.last03.get(macKey), cache.last04.get(macKey));
 ```
 
-## API
+### TypeScript API
 
 | Export | Purpose |
 |--------|---------|
 | `TEMPVO_SENSOR_MANUFACTURER_ID` | BLE company id `0x026c` |
 | `normalizeManufacturerBytes` | Strip company id prefix when present |
-| `decodeSensorBeaconPayload` | One-shot decode of payload bytes |
-| `ingestManufacturerPayload` | Update frame cache from one advertisement |
-| `buildSensorBeaconReading` | Merge cached `0x03` / `0x04` frames |
+| `decodeSensorBeaconPayload` | One-shot decode |
+| `ingestManufacturerPayload` | Update frame cache |
+| `buildSensorBeaconReading` | Merge cached frames |
 | `SensorBeaconReading` | Parsed device + measurements |
-| `SensorBeaconMeasurement` | One slot in `0x04` scan data |
-| `SensorBeaconFrameCache` | Per-device last `0x03` / `0x04` frames |
 
-Measurement types **0x01–0x22** (temperature, humidity, pressure, IAQ, CO₂, PM, etc.) are decoded to human-readable `text` on each `SensorBeaconMeasurement`.
+Measurement types **0x01–0x22** decode to human-readable `text` on each slot.
 
-## Tempivo app integration
+## Android
 
-The Tempivo web app uses the same broadcast format for live debug scans. This package is the supported **partner-facing** npm build of that decoder.
+Published artifact: `dist/tempivo-sensor-beacon.aar` (built before npm publish).
+
+```kotlin
+// app/build.gradle.kts
+dependencies {
+    implementation(
+        files(
+            "${rootProject.projectDir}/../node_modules/@tempivo/sensor-beacon/dist/tempivo-sensor-beacon.aar",
+        ),
+    )
+}
+```
+
+Adjust the path to your `node_modules` layout.
+
+```kotlin
+import com.tempivo.sensor.beacon.TempivoSensorBeaconScanner
+
+val scanner = TempivoSensorBeaconScanner(context)
+scanner.startScan { device ->
+    // device.serialNumber, device.rssi, device.telemetry, device.summary
+}
+```
+
+Declare and request `BLUETOOTH_SCAN` (API 31+) or location permissions for legacy APIs.
+
+## iOS
+
+1. **File → Add Package Dependencies… → Add Local…**
+2. Path: `node_modules/@tempivo/sensor-beacon/ios`
+3. Add product **TempivoSensorBeacon**
+4. Set **`NSBluetoothAlwaysUsageDescription`** in Info.plist
+
+```swift
+import TempivoSensorBeacon
+
+final class ScanHost: NSObject, TempivoSensorBeaconScannerDelegate {
+    private let scanner = TempivoSensorBeaconScanner()
+
+    override init() {
+        super.init()
+        scanner.delegate = self
+    }
+
+    func start() { scanner.startScanning() }
+
+    func sensorBeaconScanner(_ scanner: TempivoSensorBeaconScanner, didDiscover discovery: SensorBeaconDiscovery) {
+        print(discovery.serialNumber ?? discovery.deviceId, discovery.reading?.summary ?? "")
+    }
+}
+```
+
+Requires iOS 15+. Use a physical device for BLE.
+
+## Build locally
+
+```bash
+npm run build:ts          # dist/ only
+npm run build:android     # requires Android SDK
+npm run build:all         # both
+```
 
 ## License
 

package/android/build.gradle

@@ -0,0 +1,4 @@
+plugins {
+    id "com.android.library" version "8.7.3" apply false
+    id "org.jetbrains.kotlin.android" version "2.2.21" apply false
+}

package/android/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.1-all.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

package/android/gradle.properties

@@ -0,0 +1,3 @@
+android.useAndroidX=true
+android.suppressUnsupportedCompileSdk=36
+kotlin.code.style=official

package/android/gradlew

@@ -0,0 +1,251 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original authors.
+#
+# 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
+#
+#      https://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
+#
+
+##############################################################################
+#
+#   Gradle start up script for POSIX generated by Gradle.
+#
+#   Important for running:
+#
+#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+#       noncompliant, but you have some other compliant shell such as ksh or
+#       bash, then to run this script, type that shell name before the whole
+#       command line, like:
+#
+#           ksh Gradle
+#
+#       Busybox and similar reduced shells will NOT work, because this script
+#       requires all of these POSIX shell features:
+#         * functions;
+#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
+#
+#   Important for patching:
+#
+#   (2) This script targets any POSIX shell, so it avoids extensions provided
+#       by Bash, Ksh, etc; in particular arrays are avoided.
+#
+#       The "traditional" practice of packing multiple parameters into a
+#       space-separated string is a well documented source of bugs and security
+#       problems, so this is (mostly) avoided, by progressively accumulating
+#       options in "$@", and eventually passing that to Java.
+#
+#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+#       see the in-line comments for details.
+#
+#       There are tweaks for specific operating systems such as AIX, CygWin,
+#       Darwin, MinGW, and NonStop.
+#
+#   (3) This script is generated from the Groovy template
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       within the Gradle project.
+#
+#       You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
+    [ -h "$app_path" ]
+do
+    ls=$( ls -ld "$app_path" )
+    link=${ls#*' -> '}
+    case $link in             #(
+      /*)   app_path=$link ;; #(
+      *)    app_path=$APP_HOME$link ;;
+    esac
+done
+
+# This is normally unused
+# shellcheck disable=SC2034
+APP_BASE_NAME=${0##*/}
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+    echo "$*"
+} >&2
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in                #(
+  CYGWIN* )         cygwin=true  ;; #(
+  Darwin* )         darwin=true  ;; #(
+  MSYS* | MINGW* )  msys=true    ;; #(
+  NONSTOP* )        nonstop=true ;;
+esac
+
+CLASSPATH="\\\"\\\""
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD=$JAVA_HOME/jre/sh/java
+    else
+        JAVACMD=$JAVA_HOME/bin/java
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD=java
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+    case $MAX_FD in #(
+      max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
+        MAX_FD=$( ulimit -H -n ) ||
+            warn "Could not query maximum file descriptor limit"
+    esac
+    case $MAX_FD in  #(
+      '' | soft) :;; #(
+      *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
+        ulimit -n "$MAX_FD" ||
+            warn "Could not set maximum file descriptor limit to $MAX_FD"
+    esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+#   * args from the command line
+#   * the main class name
+#   * -classpath
+#   * -D...appname settings
+#   * --module-path (only if needed)
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+    JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    for arg do
+        if
+            case $arg in                                #(
+              -*)   false ;;                            # don't mess with options #(
+              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
+                    [ -e "$t" ] ;;                      #(
+              *)    false ;;
+            esac
+        then
+            arg=$( cygpath --path --ignore --mixed "$arg" )
+        fi
+        # Roll the args list around exactly as many times as the number of
+        # args, so each arg winds up back in the position where it started, but
+        # possibly modified.
+        #
+        # NB: a `for` loop captures its iteration list before it begins, so
+        # changing the positional parameters here affects neither the number of
+        # iterations, nor the values presented in `arg`.
+        shift                   # remove old arg
+        set -- "$@" "$arg"      # push replacement arg
+    done
+fi
+
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
+
+set -- \
+        "-Dorg.gradle.appname=$APP_BASE_NAME" \
+        -classpath "$CLASSPATH" \
+        -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
+        "$@"
+
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+#   set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+        xargs -n1 |
+        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+        tr '\n' ' '
+    )" '"$@"'
+
+exec "$JAVACMD" "$@"

package/android/library/build.gradle

@@ -0,0 +1,27 @@
+plugins {
+    id "com.android.library"
+    id "org.jetbrains.kotlin.android"
+}
+
+android {
+    namespace "com.tempivo.sensor.beacon"
+    compileSdk 36
+
+    defaultConfig {
+        minSdk 26
+        consumerProguardFiles "consumer-rules.pro"
+    }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+
+    kotlinOptions {
+        jvmTarget = "17"
+    }
+}
+
+dependencies {
+    implementation "androidx.core:core-ktx:1.17.0"
+}

package/android/library/consumer-rules.pro

@@ -0,0 +1 @@
+# Partner apps keep com.tempivo.sensor.beacon types.

package/android/library/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest />