Merge pull request code-dot-org#26715 from code-dot-org/cspx=pin-mapping

Circuit Playground Express Pin Mapping

Author: Erin Peach

apps/src/lib/kits/maker/CircuitPlaygroundBoard.js

@@ -29,6 +29,10 @@ process.hrtime = require('browser-process-hrtime');
 /** @const {number} serial port transfer rate */
 const SERIAL_BAUD = 57600;
 
+/** Maps the Circuit Playground Express pins to Circuit Playground Classic*/
+const pinMapping = {"A0": 12, "A1": 6, "A2": 9, "A3": 10, "A4": 3, "A5": 2, "A6": 0, "A7": 1};
+
+
 /**
  * Controller interface for an Adafruit Circuit Playground board using
  * Circuit Playground Firmata firmware.
@@ -228,33 +232,39 @@ export default class CircuitPlaygroundBoard extends EventEmitter {
         .then(() => forEachLedInSequence(led => led.off(), 80));
   }
 
+  mappedPin(pin) {
+    return pinMapping.hasOwnProperty(pin) ? pinMapping[pin] : pin;
+  }
+
   pinMode(pin, modeConstant) {
-    this.fiveBoard_.pinMode(pin, modeConstant);
+    this.fiveBoard_.pinMode(this.mappedPin(pin), modeConstant);
   }
 
   digitalWrite(pin, value) {
-    this.fiveBoard_.digitalWrite(pin, value);
+    this.fiveBoard_.digitalWrite(this.mappedPin(pin), value);
   }
 
   digitalRead(pin, callback) {
-    this.fiveBoard_.digitalRead(pin, callback);
+    this.fiveBoard_.digitalRead(this.mappedPin(pin), callback);
   }
 
   analogWrite(pin, value) {
-    this.fiveBoard_.analogWrite(pin, value);
+    this.fiveBoard_.analogWrite(this.mappedPin(pin), value);
   }
 
   analogRead(pin, callback) {
-    this.fiveBoard_.analogRead(pin, callback);
+    this.fiveBoard_.analogRead(this.mappedPin(pin), callback);
   }
 
   createLed(pin) {
+    pin = this.mappedPin(pin);
     const newLed = new Led({board: this.fiveBoard_, pin});
     this.dynamicComponents_.push(newLed);
     return newLed;
   }
 
   createButton(pin) {
+    pin = this.mappedPin(pin);
     const newButton = new Button({board: this.fiveBoard_, pin});
     this.dynamicComponents_.push(newButton);
     return newButton;

apps/test/unit/lib/kits/maker/CircuitPlaygroundBoardTest.js

@@ -13,6 +13,9 @@ import experiments from '@cdo/apps/util/experiments';
 // Polyfill node process.hrtime for the browser, which gets used by johnny-five
 process.hrtime = require('browser-process-hrtime');
 
+const xPins = ["A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7"];
+const classicPins = [12, 6, 9, 10, 3, 2, 0, 1];
+
 describe('CircuitPlaygroundBoard', () => {
   let board, playground;
 
@@ -275,6 +278,15 @@ describe('CircuitPlaygroundBoard', () => {
         expect(playground.pinMode).to.have.been.calledWith(pin, arg2);
       });
     });
+
+    it('forwards the call to firmata with the modified CPX value', () => {
+      return board.connect().then(() => {
+        const pin = xPins[0];
+        const arg2 = 1023;
+        board.pinMode(pin, arg2);
+        expect(playground.pinMode).to.have.been.calledWith(classicPins[0], arg2);
+      });
+    });
   });
 
   describe(`digitalWrite(pin, value)`, () => {
@@ -286,6 +298,15 @@ describe('CircuitPlaygroundBoard', () => {
         expect(playground.digitalWrite).to.have.been.calledWith(pin, arg2);
       });
     });
+
+    it('forwards the call to firmata with the modified CPX value', () => {
+      return board.connect().then(() => {
+          const pin = xPins[1];
+          const arg2 = 1023;
+          board.digitalWrite(pin, arg2);
+          expect(playground.digitalWrite).to.have.been.calledWith(classicPins[1], arg2);
+        });
+    });
   });
 
   describe(`digitalRead(pin, callback)`, () => {
@@ -297,6 +318,15 @@ describe('CircuitPlaygroundBoard', () => {
         expect(playground.digitalRead).to.have.been.calledWith(pin, arg2);
       });
     });
+
+    it('forwards the call to firmata with the modified CPX value', () => {
+      return board.connect().then(() => {
+        const pin = xPins[2];
+        const arg2 = () => {};
+        board.digitalRead(pin, arg2);
+        expect(playground.digitalRead).to.have.been.calledWith(classicPins[2], arg2);
+      });
+    });
   });
 
   describe(`analogWrite(pin, value)`, () => {
@@ -308,6 +338,15 @@ describe('CircuitPlaygroundBoard', () => {
         expect(playground.analogWrite).to.have.been.calledWith(pin, arg2);
       });
     });
+
+    it('forwards the call to firmata with the modified CPX value', () => {
+      return board.connect().then(() => {
+        const pin = xPins[3];
+        const arg2 = 1023;
+        board.analogWrite(pin, arg2);
+        expect(playground.analogWrite).to.have.been.calledWith(classicPins[3], arg2);
+      });
+    });
   });
 
   describe(`analogRead(pin, callback)`, () => {
@@ -319,6 +358,15 @@ describe('CircuitPlaygroundBoard', () => {
         expect(playground.analogRead).to.have.been.calledWith(pin, arg2);
       });
     });
+
+    it('forwards the call to firmata with the modified CPX value', () => {
+      return board.connect().then(() => {
+        const pin = xPins[4];
+        const arg2 = () => {};
+        board.analogRead(pin, arg2);
+        expect(playground.analogRead).to.have.been.calledWith(classicPins[4], arg2);
+      });
+    });
   });
 
   describe(`boardConnected()`, () => {
@@ -349,6 +397,14 @@ describe('CircuitPlaygroundBoard', () => {
         expect(newLed).to.be.an.instanceOf(Led);
       });
     });
+
+    it('uses the express pin value to make an LED controller with the classic pin value', () => {
+      return board.connect().then(() => {
+        const pin = xPins[5];
+        const newLed = board.createLed(pin);
+        expect(newLed.pin).to.equal(classicPins[5]);
+      });
+    });
   });
 
   describe(`createButton(pin)`, () => {
@@ -360,6 +416,14 @@ describe('CircuitPlaygroundBoard', () => {
       });
     });
 
+    it('uses the express pin value to make a button controller with the classic pin value', () => {
+      return board.connect().then(() => {
+        const pin = xPins[6];
+        const newLed = board.createButton(pin);
+        expect(newLed.pin).to.equal(classicPins[6]);
+      });
+    });
+
     it('configures the controller as a pullup if passed an external pin', () => {
       return board.connect().then(() => {
         EXTERNAL_PINS.forEach((pin) => {
@@ -380,4 +444,12 @@ describe('CircuitPlaygroundBoard', () => {
       });
     });
   });
+
+  describe(`mappedPin(pin)`, () => {
+    it(`returns the Classic pin value of the provided Express pin value`, () =>{
+      for (let i = 0; i < xPins.length; i++) {
+        expect(board.mappedPin(xPins[i])).to.equal(classicPins[i]);
+      }
+    });
+  });
 });