ble-pybricks-service: rename slot to progId

Rename the requested program ID from slot to progId and the running
program ID to runningProgId. These can also have the value of built-in
programs, not just slot numbers, so it doesn't make sense to call them
slots.

Author: dlech

src/ble-pybricks-service/actions.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// Copyright (c) 2021-2024 The Pybricks Authors
+// Copyright (c) 2021-2025 The Pybricks Authors
 //
 // Actions for Bluetooth Low Energy Pybricks service
 
@@ -81,15 +81,17 @@ export const sendLegacyStartReplCommand = createAction((id: number) => ({
 /**
  * Action that requests a start user program to be sent.
  * @param id Unique identifier for this transaction.
- * @param slot The slot number of the user program to start.
+ * @param progId The program ID number of the user program to start.
  *
  * @since Pybricks Profile v1.4.0
  */
-export const sendStartUserProgramCommand = createAction((id: number, slot: number) => ({
-    type: 'blePybricksServiceCommand.action.sendStartUserProgram',
-    id,
-    slot,
-}));
+export const sendStartUserProgramCommand = createAction(
+    (id: number, progId: number) => ({
+        type: 'blePybricksServiceCommand.action.sendStartUserProgram',
+        id,
+        progId,
+    }),
+);
 
 /**
  * Action that requests to write user program metadata.
@@ -180,13 +182,13 @@ export const didFailToSendCommand = createAction((id: number, error: Error) => (
 /**
  * Action that represents a status report event received from the hub.
  * @param statusFlags The status flags.
- * @param slot The slot number of the user program that is running.
+ * @param progId The ID number of the user program that is running.
  */
 export const didReceiveStatusReport = createAction(
-    (statusFlags: number, slot: number) => ({
+    (statusFlags: number, runningProgId: number) => ({
         type: 'blePybricksServiceEvent.action.didReceiveStatusReport',
         statusFlags,
-        slot,
+        runningProgId,
     }),
 );
 

src/ble-pybricks-service/protocol.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// Copyright (c) 2020-2024 The Pybricks Authors
+// Copyright (c) 2020-2025 The Pybricks Authors
 //
 // Definitions related to the Pybricks Bluetooth low energy GATT service.
 
@@ -112,17 +112,17 @@ export function createStopUserProgramCommand(): Uint8Array {
  * Creates a {@link CommandType.StartUserProgram} message.
  *
  * Parameters:
- * - slot: Program identifier (one byte). Slots 0--127 are reserved for
+ * - progId: Program identifier (one byte). Slots 0--127 are reserved for
  *   downloaded user programs. Slots 128--255 are for builtin user programs.
  *
  * @since Pybricks Profile v1.4.0
  */
 export function createStartUserProgramCommand(
-    slot: number | BuiltinProgramId,
+    progId: number | BuiltinProgramId,
 ): Uint8Array {
     const msg = new Uint8Array(2);
     msg[0] = CommandType.StartUserProgram;
-    msg[1] = slot;
+    msg[1] = progId;
     return msg;
 }
 
@@ -303,15 +303,18 @@ export function getEventType(msg: DataView): EventType {
 /**
  * Parses the payload of a status report message.
  * @param msg The raw message data.
- * @returns The status as bit flags and the slot number of the running program.
+ * @returns The status as bit flags and the program ID number of the running program.
  *
  * @since Pybricks Profile v1.0.0 - changed in v1.4.0
  */
-export function parseStatusReport(msg: DataView): { flags: number; slot: number } {
+export function parseStatusReport(msg: DataView): {
+    flags: number;
+    runningProgId: number;
+} {
     assert(msg.getUint8(0) === EventType.StatusReport, 'expecting status report event');
     return {
         flags: msg.getUint32(1, true),
-        slot: msg.byteLength > 5 ? msg.getUint8(5) : 0,
+        runningProgId: msg.byteLength > 5 ? msg.getUint8(5) : 0,
     };
 }
 

src/ble-pybricks-service/sagas.test.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// Copyright (c) 2021-2024 The Pybricks Authors
+// Copyright (c) 2021-2025 The Pybricks Authors
 
 import { AsyncSaga } from '../../test';
 import {
@@ -35,11 +35,11 @@ describe('command encoder', () => {
             ],
         ],
         [
-            'start user program with slot',
+            'start user program with program id',
             sendStartUserProgramCommand(0, 0x2a),
             [
                 0x01, // start user program command
-                0x2a, // program slot
+                0x2a, // program ID
             ],
         ],
         [
@@ -192,7 +192,7 @@ describe('event decoder', () => {
                 0x00, // .
                 0x00, // .
                 0x00, // flags count MSB
-                0x80, // slot
+                0x80, // program ID
             ],
             didReceiveStatusReport(0x00000001, BuiltinProgramId.REPL),
         ],

src/ble-pybricks-service/sagas.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// Copyright (c) 2021-2024 The Pybricks Authors
+// Copyright (c) 2021-2025 The Pybricks Authors
 //
 // Handles Pybricks protocol.
 
@@ -75,7 +75,7 @@ function* encodeRequest(): Generator {
             yield* put(writeCommand(action.id, createLegacyStartReplCommand()));
         } else if (sendStartUserProgramCommand.matches(action)) {
             yield* put(
-                writeCommand(action.id, createStartUserProgramCommand(action.slot)),
+                writeCommand(action.id, createStartUserProgramCommand(action.progId)),
             );
         } else if (sendWriteUserProgramMetaCommand.matches(action)) {
             yield* put(
@@ -127,7 +127,7 @@ function* decodeResponse(action: ReturnType<typeof didNotifyEvent>): Generator {
         switch (responseType) {
             case EventType.StatusReport: {
                 const status = parseStatusReport(action.value);
-                yield* put(didReceiveStatusReport(status.flags, status.slot));
+                yield* put(didReceiveStatusReport(status.flags, status.runningProgId));
                 break;
             }
             case EventType.WriteStdout: