@microbit/microbit-connection 0.9.0-apps.alpha.18 → 0.9.0-apps.alpha.19

package/build/esm/microbit-events.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Well-known micro:bit message bus event source IDs and values.
+ *
+ * Source IDs differ between V1 (DAL) and V2 (CODAL). Event values are
+ * identical across versions (V2 adds TwoG to gesture values).
+ *
+ * @see https://lancaster-university.github.io/microbit-docs/
+ */
+/**
+ * Event source IDs for micro:bit V1 (DAL).
+ */
+export declare const V1Source: {
+    readonly ButtonA: 1;
+    readonly ButtonB: 2;
+    readonly ButtonAB: 26;
+    readonly Gesture: 27;
+};
+/**
+ * Event source IDs for micro:bit V2 (CODAL).
+ */
+export declare const V2Source: {
+    readonly ButtonA: 1;
+    readonly ButtonB: 2;
+    readonly ButtonAB: 3;
+    readonly Gesture: 13;
+    readonly Logo: 121;
+};
+export declare const EventSource: {
+    readonly v1: {
+        readonly ButtonA: 1;
+        readonly ButtonB: 2;
+        readonly ButtonAB: 26;
+        readonly Gesture: 27;
+    };
+    readonly v2: {
+        readonly ButtonA: 1;
+        readonly ButtonB: 2;
+        readonly ButtonAB: 3;
+        readonly Gesture: 13;
+        readonly Logo: 121;
+    };
+};
+export declare const GestureEvent: {
+    readonly TiltUp: 1;
+    readonly TiltDown: 2;
+    readonly TiltLeft: 3;
+    readonly TiltRight: 4;
+    readonly FaceUp: 5;
+    readonly FaceDown: 6;
+    readonly Freefall: 7;
+    readonly Acceleration3g: 8;
+    readonly Acceleration6g: 9;
+    readonly Acceleration8g: 10;
+    readonly Shake: 11;
+    /** V2 only. */
+    readonly Acceleration2g: 12;
+};
+export type GestureEvent = (typeof GestureEvent)[keyof typeof GestureEvent];
+export declare const ButtonAction: {
+    readonly Down: 1;
+    readonly Up: 2;
+    readonly Click: 3;
+    readonly LongClick: 4;
+    readonly Hold: 5;
+    readonly DoubleClick: 6;
+};
+export type ButtonAction = (typeof ButtonAction)[keyof typeof ButtonAction];

package/build/esm/microbit-events.js

@@ -0,0 +1,52 @@
+/**
+ * Well-known micro:bit message bus event source IDs and values.
+ *
+ * Source IDs differ between V1 (DAL) and V2 (CODAL). Event values are
+ * identical across versions (V2 adds TwoG to gesture values).
+ *
+ * @see https://lancaster-university.github.io/microbit-docs/
+ */
+/**
+ * Event source IDs for micro:bit V1 (DAL).
+ */
+export const V1Source = {
+    ButtonA: 1,
+    ButtonB: 2,
+    ButtonAB: 26,
+    Gesture: 27,
+};
+/**
+ * Event source IDs for micro:bit V2 (CODAL).
+ */
+export const V2Source = {
+    ButtonA: 1,
+    ButtonB: 2,
+    ButtonAB: 3,
+    Gesture: 13,
+    Logo: 121,
+};
+export const EventSource = { v1: V1Source, v2: V2Source };
+export const GestureEvent = {
+    TiltUp: 1,
+    TiltDown: 2,
+    TiltLeft: 3,
+    TiltRight: 4,
+    FaceUp: 5,
+    FaceDown: 6,
+    Freefall: 7,
+    Acceleration3g: 8,
+    Acceleration6g: 9,
+    Acceleration8g: 10,
+    Shake: 11,
+    /** V2 only. */
+    Acceleration2g: 12,
+};
+export const ButtonAction = {
+    Down: 1,
+    Up: 2,
+    Click: 3,
+    LongClick: 4,
+    Hold: 5,
+    DoubleClick: 6,
+};
+//# sourceMappingURL=microbit-events.js.map

package/build/esm/microbit-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"microbit-events.js","sourceRoot":"","sources":["../../src/microbit-events.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,CAAC;IACV,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,EAAE;CACH,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,CAAC;IACV,QAAQ,EAAE,CAAC;IACX,OAAO,EAAE,EAAE;IACX,IAAI,EAAE,GAAG;CACD,CAAC;AAEX,MAAM,CAAC,MAAM,WAAW,GAAG,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAW,CAAC;AAEnE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,MAAM,EAAE,CAAC;IACT,QAAQ,EAAE,CAAC;IACX,QAAQ,EAAE,CAAC;IACX,SAAS,EAAE,CAAC;IACZ,MAAM,EAAE,CAAC;IACT,QAAQ,EAAE,CAAC;IACX,QAAQ,EAAE,CAAC;IACX,cAAc,EAAE,CAAC;IACjB,cAAc,EAAE,CAAC;IACjB,cAAc,EAAE,EAAE;IAClB,KAAK,EAAE,EAAE;IACT,eAAe;IACf,cAAc,EAAE,EAAE;CACV,CAAC;AAGX,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,IAAI,EAAE,CAAC;IACP,EAAE,EAAE,CAAC;IACL,KAAK,EAAE,CAAC;IACR,SAAS,EAAE,CAAC;IACZ,IAAI,EAAE,CAAC;IACP,WAAW,EAAE,CAAC;CACN,CAAC"}

package/build/esm/service-events.d.ts

@@ -1,4 +1,5 @@
 import { DeviceConnectionEventMap } from "./device.js";
+import type { GestureEvent, ButtonAction } from "./microbit-events.js";
 export interface AccelerometerData {
     x: number;
     y: number;
@@ -10,7 +11,7 @@ export declare const ButtonState: {
     readonly LongPress: 2;
 };
 export type ButtonState = (typeof ButtonState)[keyof typeof ButtonState];
-export type ButtonEventType = "buttonachanged" | "buttonbchanged";
+export type ButtonActionType = "buttonachanged" | "buttonbchanged";
 export interface ButtonData {
     button: "A" | "B";
     state: ButtonState;
@@ -26,6 +27,45 @@ export interface MagnetometerData {
     y: number;
     z: number;
 }
+export interface TemperatureData {
+    celsius: number;
+}
+export interface PinValue {
+    /** Pin number (0-18). */
+    pin: number;
+    /**
+     * Pin value. For digital pins: 0 or 1.
+     * For analog pins: 0-255 (the 10-bit analog reading scaled to 8 bits).
+     */
+    value: number;
+}
+/**
+ * Data from a `pinchanged` event.
+ *
+ * Contains only the input pins whose values changed since the last
+ * notification, up to a firmware limit of 10 pins per event
+ * (lowest-numbered first). Use {@link MicrobitBluetoothConnection.readPins}
+ * to read all input pins on demand.
+ */
+export interface PinData {
+    data: PinValue[];
+}
+export interface GestureData {
+    gesture: GestureEvent;
+}
+export interface ButtonActionData {
+    button: "A" | "B" | "AB" | "Logo";
+    action: ButtonAction;
+}
+/**
+ * A raw event from the micro:bit's message bus, received via the
+ * BLE Event Service. Use {@link MicrobitBluetoothConnection.subscribeToEvent}
+ * to register which events the micro:bit should forward.
+ */
+export interface MicrobitEventData {
+    source: number;
+    value: number;
+}
 export interface UartData {
     value: Uint8Array;
 }
@@ -38,6 +78,14 @@ export interface ServiceConnectionEventMap {
     buttonachanged: ButtonData;
     buttonbchanged: ButtonData;
     magnetometerdatachanged: MagnetometerData;
+    temperaturechanged: TemperatureData;
+    pinchanged: PinData;
+    gesturechanged: GestureData;
+    buttonaaction: ButtonActionData;
+    buttonbaction: ButtonActionData;
+    buttonabaction: ButtonActionData;
+    logoaction: ButtonActionData;
+    microbitevent: MicrobitEventData;
     uartdata: UartData;
 }
 type AllEventMap = ServiceConnectionEventMap & DeviceConnectionEventMap;

package/build/esm/service-events.js.map

@@ -1 +1 @@
-{"version":3,"file":"service-events.js","sourceRoot":"","sources":["../../src/service-events.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,UAAU,EAAE,CAAC;IACb,UAAU,EAAE,CAAC;IACb,SAAS,EAAE,CAAC;CACJ,CAAC"}
+{"version":3,"file":"service-events.js","sourceRoot":"","sources":["../../src/service-events.ts"],"names":[],"mappings":"AASA,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,UAAU,EAAE,CAAC;IACb,UAAU,EAAE,CAAC;IACb,SAAS,EAAE,CAAC;CACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microbit/microbit-connection",
-  "version": "0.9.0-apps.alpha.18",
+  "version": "0.9.0-apps.alpha.19",
   "main": "./build/cjs/index.js",
   "module": "./build/esm/index.js",
   "types": "./build/esm/index.d.ts",