node-toypad 2.0.0

package/README.md

@@ -0,0 +1,30 @@
+# node-toypad - A JavaScript module to control the LEGO Dimensions ToyPad
+
+### Installation
+
+Node.js v22.0+ required.
+
+`npm install node-toypad --save`
+
+### Reading tags
+
+```js
+import { ToyPad, TagType } from "node-toypad";
+
+const toyPad = new ToyPad();
+
+toyPad.on("add", async (event) => {
+  const { id, type } = await toyPad.readTag(event.panel, event.signature);
+  if (type === TagType.Character) {
+    const character = ToyPad.metadata.getCharacterById(id);
+    console.log(`Character ${character?.name ?? id}`);
+  } else {
+    const vehicle = ToyPad.metadata.getVehicleById(id);
+    console.log(`Vehicle ${vehicle?.name ?? id}`);
+  }
+});
+
+await toyPad.connect();
+```
+
+More examples are available in the `examples` directory.

package/data/minifigs.json

@@ -0,0 +1,77 @@
+[
+    { "id": 1, "name": "Batman", "world": "DC Comics" },
+    { "id": 2, "name": "Gandalf", "world": "Lord of the Rings" },
+    { "id": 3, "name": "Wyldstyle", "world": "The LEGO Movie" },
+    { "id": 4, "name": "Aquaman", "world": "DC Comics" },
+    { "id": 5, "name": "Bad Cop", "world": "The LEGO Movie" },
+    { "id": 6, "name": "Bane", "world": "DC Comics" },
+    { "id": 7, "name": "Bart", "world": "The Simpsons" },
+    { "id": 8, "name": "Benny", "world": "The LEGO Movie" },
+    { "id": 9, "name": "Chell", "world": "Portal 2" },
+    { "id": 10, "name": "Cole", "world": "Ninjago" },
+    { "id": 11, "name": "Cragger", "world": "Legends of Chima" },
+    { "id": 12, "name": "Cyborg", "world": "DC Comics" },
+    { "id": 13, "name": "Cyberman", "world": "Doctor Who" },
+    { "id": 14, "name": "Doc Brown", "world": "Back to the Future" },
+    { "id": 15, "name": "The Doctor", "world": "Doctor Who" },
+    { "id": 16, "name": "Emmet", "world": "The LEGO Movie" },
+    { "id": 17, "name": "Eris", "world": "Legends of Chima" },
+    { "id": 18, "name": "Gimli", "world": "Lord of the Rings" },
+    { "id": 19, "name": "Smeagol", "world": "Lord of the Rings" },
+    { "id": 20, "name": "Harley Quinn", "world": "DC Comics" },
+    { "id": 21, "name": "Homer", "world": "The Simpsons" },
+    { "id": 22, "name": "Jay", "world": "Ninjago" },
+    { "id": 23, "name": "Joker", "world": "DC Comics" },
+    { "id": 24, "name": "Kai", "world": "Ninjago" },
+    { "id": 25, "name": "ACU Officer", "world": "Jurassic World" },
+    { "id": 26, "name": "Gamer Kid", "world": "Midway Arcade" },
+    { "id": 27, "name": "Krusty", "world": "The Simpsons" },
+    { "id": 28, "name": "Laval", "world": "Legends of Chima" },
+    { "id": 29, "name": "Legolas", "world": "Lord of the Rings" },
+    { "id": 30, "name": "Lloyd", "world": "Ninjago" },
+    { "id": 31, "name": "Marty McFly", "world": "Back to the Future" },
+    { "id": 32, "name": "Nya", "world": "Ninjago" },
+    { "id": 33, "name": "Owen", "world": "Jurassic World" },
+    { "id": 34, "name": "Peter Venkman", "world": "Ghostbusters" },
+    { "id": 35, "name": "Slimer", "world": "Ghostbusters" },
+    { "id": 36, "name": "Scooby Doo", "world": "Scooby-Doo" },
+    { "id": 37, "name": "Sensei Wu", "world": "Ninjago" },
+    { "id": 38, "name": "Shaggy", "world": "Scooby-Doo" },
+    { "id": 39, "name": "Stay Puft", "world": "Ghostbusters" },
+    { "id": 40, "name": "Superman", "world": "DC Comics" },
+    { "id": 41, "name": "Unikitty", "world": "The LEGO Movie" },
+    { "id": 42, "name": "Wicked Witch", "world": "Wizard of Oz" },
+    { "id": 43, "name": "Superwoman", "world": "DC Comics" },
+    { "id": 44, "name": "Zane", "world": "Ninjago" },
+    { "id": 45, "name": "Green Arrow", "world": "DC Comics" },
+    { "id": 46, "name": "Supergirl", "world": "DC Comics" },
+    { "id": 47, "name": "Abby Yates", "world": "Ghostbusters 2016" },
+    { "id": 48, "name": "Finn", "world": "Adventure Time" },
+    { "id": 49, "name": "Ethan Hunt", "world": "Mission Impossible" },
+    { "id": 50, "name": "Lumpy Space Princess", "world": "Adventure Time" },
+    { "id": 51, "name": "Jake", "world": "Adventure Time" },
+    { "id": 52, "name": "Harry Potter", "world": "Harry Potter" },
+    { "id": 53, "name": "Voldemort", "world": "Harry Potter" },
+    { "id": 54, "name": "Michael Knight", "world": "Knight Rider" },
+    { "id": 55, "name": "B.A. Baracus", "world": "The A-Team" },
+    { "id": 56, "name": "Newt", "world": "Fantastic Beasts" },
+    { "id": 57, "name": "Sonic", "world": "Sonic the Hedgehog" },
+    { "id": 59, "name": "Gizmo", "world": "Gremlins" },
+    { "id": 60, "name": "Stripe", "world": "Gremlins" },
+    { "id": 61, "name": "E.T.", "world": "E.T." },
+    { "id": 62, "name": "Tina", "world": "Fantastic Beasts" },
+    { "id": 63, "name": "Marceline", "world": "Adventure Time" },
+    { "id": 64, "name": "Bat Girl", "world": "LEGO Batman Movie" },
+    { "id": 65, "name": "Robin", "world": "LEGO Batman Movie" },
+    { "id": 66, "name": "Sloth", "world": "The Goonies" },
+    { "id": 67, "name": "Hermione Granger", "world": "Harry Potter" },
+    { "id": 68, "name": "Chase McCain", "world": "LEGO City" },
+    { "id": 69, "name": "Excalibur Batman", "world": "LEGO Batman Movie" },
+    { "id": 70, "name": "Raven", "world": "Teen Titans Go" },
+    { "id": 71, "name": "Beast Boy", "world": "Teen Titans Go" },
+    { "id": 72, "name": "Beetle Juice", "world": "Beetle Juice" },
+    { "id": 74, "name": "Blossom", "world": "Power Puff Girls" },
+    { "id": 75, "name": "Bubbles", "world": "Power Puff Girls" },
+    { "id": 76, "name": "Buttercup", "world": "Power Puff Girls" },
+    { "id": 77, "name": "Star Fire", "world": "Teen Titans Go" }
+]

package/data/upgrades.json

@@ -0,0 +1,246 @@
+[
+    { "id": 1, "label": "Model Boost Ability" },
+    { "id": 2, "label": "Movement Speed Buff 1" },
+    { "id": 3, "label": "Jump Ability" },
+    { "id": 4, "label": "Boost Buff 1" },
+    { "id": 5, "label": "Boost Buff 2" },
+    { "id": 6, "label": "Movement Speed Buff 2" },
+    { "id": 7, "label": "Instant Accelerator Switch Ability" },
+    { "id": 8, "label": "Boost Buff 3" },
+    { "id": 9, "label": "Movement Speed Buff 3" },
+    { "id": 10, "label": "Color Changing Bolts Ability" },
+    { "id": 11, "label": "Fire Speed Buff 1" },
+    { "id": 12, "label": "Health Buff" },
+    { "id": 13, "label": "Instant Tow Bar" },
+    { "id": 14, "label": "Fire Speed Buff 2" },
+    { "id": 15, "label": "Health Buff" },
+    { "id": 16, "label": "Fast Jet Flyer Ability" },
+    { "id": 17, "label": "Fire Speed Buff" },
+    { "id": 18, "label": "Health Buff" },
+    { "id": 19, "label": "Mine Weapon" },
+    { "id": 21, "label": "Explode Ability" },
+    { "id": 22, "label": "Spinning Weapon" },
+    { "id": 24, "label": "Electric Shield" },
+    { "id": 25, "label": "Swarm Weapon" },
+    { "id": 27, "label": "Speaker Attack Ability" },
+    { "id": 28, "label": "Bolt Color Chooser" },
+    { "id": 29, "label": "Enemy Hearts Ability" },
+    { "id": 30, "label": "Regenerate Armor Ability" },
+    { "id": 31, "label": "Horn Sound Chooser" },
+    { "id": 32, "label": "Guardian Ability" },
+    { "id": 33, "label": "Character Studs Ability" },
+    { "id": 34, "label": "Engine Sounds Chooser" },
+    { "id": 35, "label": "Extra Life" },
+    { "id": 36, "label": "Stud Magnet Ability" },
+    { "id": 37, "label": "Skin 1" },
+    { "id": 38, "label": "Tire Color Chooser" },
+    { "id": 39, "label": "Exhaust Color Chooser" },
+    { "id": 40, "label": "Skin 2" },
+    { "id": 41, "label": "Headlight Color Chooser" },
+    { "id": 42, "label": "Under Light Chooser" },
+    { "id": 43, "label": "Skin 3" },
+    { "id": 44, "label": "Model Color Chooser" },
+    { "id": 45, "label": "Chrome Armor Chooser" },
+    { "id": 46, "label": "Model Boost Ability" },
+    { "id": 47, "label": "Boost Buff 1" },
+    { "id": 48, "label": "Movement Speed Buff 1" },
+    { "id": 49, "label": "Jump Ability" },
+    { "id": 50, "label": "Boost Buff 2" },
+    { "id": 51, "label": "Movement Speed Buff 2" },
+    { "id": 52, "label": "Upgraded Silver LEGO Blowup Ability" },
+    { "id": 53, "label": "Boost Buff 3" },
+    { "id": 54, "label": "Movement Speed Buff 3" },
+    { "id": 55, "label": "Color Changing Bolts Ability" },
+    { "id": 56, "label": "Fire Speed Buff 1" },
+    { "id": 57, "label": "Health Buff" },
+    { "id": 58, "label": "Fire Speed Buff 2" },
+    { "id": 59, "label": "Health Buff" },
+    { "id": 61, "label": "Barrel Roll Ability" },
+    { "id": 62, "label": "Fire Speed Buff" },
+    { "id": 63, "label": "Health Buff" },
+    { "id": 64, "label": "Mine Weapon" },
+    { "id": 66, "label": "Explode Ability" },
+    { "id": 67, "label": "Spinning Weapon" },
+    { "id": 69, "label": "Electric Shield" },
+    { "id": 70, "label": "Swarm Weapon" },
+    { "id": 72, "label": "Speaker Attack Ability" },
+    { "id": 73, "label": "Bolt Color Chooser" },
+    { "id": 74, "label": "Enemy Hearts Ability" },
+    { "id": 75, "label": "Regenerate Armor Ability" },
+    { "id": 76, "label": "Horn Sound Chooser" },
+    { "id": 77, "label": "Guardian Ability" },
+    { "id": 78, "label": "Character Studs Ability" },
+    { "id": 79, "label": "Engine Sounds Chooser" },
+    { "id": 80, "label": "Extra Life" },
+    { "id": 81, "label": "Stud Magnet Ability" },
+    { "id": 82, "label": "Skin 1" },
+    { "id": 83, "label": "Trail Color Chooser" },
+    { "id": 84, "label": "Exhaust Color Chooser" },
+    { "id": 85, "label": "Skin 2" },
+    { "id": 86, "label": "Headlight Color Chooser" },
+    { "id": 87, "label": "Under Light Chooser" },
+    { "id": 88, "label": "Skin 3" },
+    { "id": 89, "label": "Model Color Chooser" },
+    { "id": 90, "label": "Chrome Armor Chooser" },
+    { "id": 91, "label": "Model Boost Ability" },
+    { "id": 92, "label": "Boost Buff 1" },
+    { "id": 93, "label": "Movement Speed Buff 1" },
+    { "id": 94, "label": "Jump Ability" },
+    { "id": 95, "label": "Boost Buff 2" },
+    { "id": 96, "label": "Movement Speed Buff 2" },
+    { "id": 97, "label": "Spin Attack" },
+    { "id": 98, "label": "Boost Buff 3" },
+    { "id": 99, "label": "Movement Speed Buff 3" },
+    { "id": 100, "label": "Color Changing Bolts Ability" },
+    { "id": 101, "label": "Fire Speed Buff 1" },
+    { "id": 102, "label": "Health Buff" },
+    { "id": 103, "label": "Turret Speed Buff" },
+    { "id": 104, "label": "Fire Speed Buff 2" },
+    { "id": 105, "label": "Instant Gold LEGO Laser Objects" },
+    { "id": 106, "label": "Health Buff" },
+    { "id": 107, "label": "Fire Speed Buff" },
+    { "id": 108, "label": "Health Buff" },
+    { "id": 109, "label": "Mine Weapon" },
+    { "id": 111, "label": "Explode Ability" },
+    { "id": 112, "label": "Spinning Weapon" },
+    { "id": 114, "label": "Electric Shield" },
+    { "id": 115, "label": "Swarm Weapon" },
+    { "id": 117, "label": "Speaker Attack Ability" },
+    { "id": 118, "label": "Bolt Color Chooser" },
+    { "id": 119, "label": "Enemy Hearts Ability" },
+    { "id": 120, "label": "Regenerate Armor Ability" },
+    { "id": 121, "label": "Horn Sound Chooser" },
+    { "id": 122, "label": "Guardian Ability" },
+    { "id": 123, "label": "Character Studs Ability" },
+    { "id": 124, "label": "Engine Sounds Chooser" },
+    { "id": 125, "label": "Extra Life" },
+    { "id": 126, "label": "Stud Magnet Ability" },
+    { "id": 127, "label": "Skin 1" },
+    { "id": 128, "label": "Trail Color Chooser" },
+    { "id": 129, "label": "Eye Glow Chooser" },
+    { "id": 130, "label": "Skin 2" },
+    { "id": 131, "label": "Exhaust Color Chooser" },
+    { "id": 132, "label": "Under Light Chooser" },
+    { "id": 133, "label": "Skin 3" },
+    { "id": 134, "label": "Model Color Chooser" },
+    { "id": 135, "label": "Chrome Armor Chooser" },
+    { "id": 136, "label": "Model Boost Ability" },
+    { "id": 137, "label": "Boost Buff 1" },
+    { "id": 138, "label": "Movement Speed Buff 1" },
+    { "id": 139, "label": "Barrel Roll Ability" },
+    { "id": 140, "label": "Boost Buff 2" },
+    { "id": 141, "label": "Movement Speed Buff 2" },
+    { "id": 142, "label": "Powerful Superweapon" },
+    { "id": 143, "label": "Boost Buff 3" },
+    { "id": 144, "label": "Movement Speed Buff 3" },
+    { "id": 145, "label": "Color Changing Bolts Ability" },
+    { "id": 146, "label": "Fire Speed Buff 1" },
+    { "id": 147, "label": "Health Buff" },
+    { "id": 148, "label": "Fire Speed Buff 2" },
+    { "id": 149, "label": "Health Buff" },
+    { "id": 151, "label": "Upgraded Silver LEGO Blowup Ability" },
+    { "id": 152, "label": "Fire Speed Buff" },
+    { "id": 153, "label": "Health Buff" },
+    { "id": 154, "label": "Mine Weapon" },
+    { "id": 156, "label": "Explode Ability" },
+    { "id": 157, "label": "Spinning Weapon" },
+    { "id": 159, "label": "Electric Shield" },
+    { "id": 160, "label": "Swarm Weapon" },
+    { "id": 162, "label": "Speaker Attack Ability" },
+    { "id": 163, "label": "Bolt Color Chooser" },
+    { "id": 164, "label": "Enemy Hearts Ability" },
+    { "id": 165, "label": "Regenerate Armor Ability" },
+    { "id": 166, "label": "Roar Sound Chooser" },
+    { "id": 167, "label": "Guardian Ability" },
+    { "id": 168, "label": "Character Studs Ability" },
+    { "id": 169, "label": "Engine Sounds Chooser" },
+    { "id": 170, "label": "Extra Life" },
+    { "id": 171, "label": "Stud Magnet Ability" },
+    { "id": 172, "label": "Skin 1" },
+    { "id": 173, "label": "Trail Color Chooser" },
+    { "id": 175, "label": "Skin 2" },
+    { "id": 176, "label": "Eye Glow Chooser" },
+    { "id": 177, "label": "Under Light Chooser" },
+    { "id": 178, "label": "Skin 3" },
+    { "id": 179, "label": "Model Color Chooser" },
+    { "id": 180, "label": "Chrome Armor Chooser" },
+    { "id": 181, "label": "Speed 1" },
+    { "id": 182, "label": "Speed 2" },
+    { "id": 183, "label": "Speed 3" },
+    { "id": 184, "label": "Speed 4" },
+    { "id": 185, "label": "Speed 5" },
+    { "id": 186, "label": "Speed 6" },
+    { "id": 187, "label": "Speed 7" },
+    { "id": 188, "label": "Speed 8" },
+    { "id": 189, "label": "Speed 9" },
+    { "id": 190, "label": "Power 1" },
+    { "id": 191, "label": "Power 2" },
+    { "id": 193, "label": "Power 4" },
+    { "id": 194, "label": "Power 5" },
+    { "id": 195, "label": "Power 6" },
+    { "id": 196, "label": "Power 7" },
+    { "id": 197, "label": "Power 8" },
+    { "id": 198, "label": "Power 9" },
+    { "id": 199, "label": "Weapons 1" },
+    { "id": 201, "label": "Weapons 3" },
+    { "id": 202, "label": "Weapons 4" },
+    { "id": 205, "label": "Weapons 7" },
+    { "id": 207, "label": "Weapons 9" },
+    { "id": 208, "label": "Extras 1" },
+    { "id": 209, "label": "Extras 2" },
+    { "id": 210, "label": "Extras 3" },
+    { "id": 211, "label": "Extras 4" },
+    { "id": 212, "label": "Extras 5" },
+    { "id": 213, "label": "Extras 6" },
+    { "id": 214, "label": "Extras 7" },
+    { "id": 215, "label": "Extras 8" },
+    { "id": 216, "label": "Extras 9" },
+    { "id": 217, "label": "Colors 1" },
+    { "id": 218, "label": "Colors 2" },
+    { "id": 219, "label": "Colors 3" },
+    { "id": 220, "label": "Colors 4" },
+    { "id": 221, "label": "Colors 5" },
+    { "id": 222, "label": "Colors 6" },
+    { "id": 223, "label": "Colors 7" },
+    { "id": 224, "label": "Colors 8" },
+    { "id": 225, "label": "Colors 9" },
+    { "id": 226, "label": "Follower Ability" },
+    { "id": 227, "label": "Movement Speed Buff 1" },
+    { "id": 228, "label": "Health Buff" },
+    { "id": 229, "label": "Spin Attack" },
+    { "id": 230, "label": "Movement Speed Buff 2" },
+    { "id": 231, "label": "Health Buff" },
+    { "id": 232, "label": "Spin Attack Buff" },
+    { "id": 233, "label": "Movement Speed Buff 3" },
+    { "id": 234, "label": "Health Buff" },
+    { "id": 235, "label": "Skin 1" },
+    { "id": 236, "label": "Trail Color Chooser" },
+    { "id": 238, "label": "Skin 2" },
+    { "id": 239, "label": "Model Color Chooser" },
+    { "id": 241, "label": "Skin 3" },
+    { "id": 242, "label": "Chrome Armor Chooser" },
+    { "id": 244, "label": "Creature Glow Chooser" },
+    { "id": 245, "label": "Enemy Hearts Ability" },
+    { "id": 247, "label": "Spin Color Chooser" },
+    { "id": 248, "label": "Extra Life" },
+    { "id": 250, "label": "Creature Sound Chooser" },
+    { "id": 251, "label": "Heart Giver Ability" },
+    { "id": 271, "label": "Follower Ability" },
+    { "id": 272, "label": "Movement Speed Buff 1" },
+    { "id": 273, "label": "Character Ability Buff 1" },
+    { "id": 274, "label": "Spin Attack" },
+    { "id": 275, "label": "Movement Speed Buff 2" },
+    { "id": 276, "label": "Character Ability Buff 2" },
+    { "id": 277, "label": "Spin Attack Buff" },
+    { "id": 278, "label": "Movement Speed Buff 3" },
+    { "id": 279, "label": "Character Ability Buff 3" },
+    { "id": 280, "label": "Skin 1" },
+    { "id": 281, "label": "Trail Color Chooser" },
+    { "id": 283, "label": "Skin 2" },
+    { "id": 284, "label": "Model Color Chooser" },
+    { "id": 286, "label": "Skin 3" },
+    { "id": 287, "label": "Chrome Armor Chooser" },
+    { "id": 289, "label": "Creature Glow Chooser" },
+    { "id": 292, "label": "Spin Color Chooser" },
+    { "id": 295, "label": "Heart Giver Ability" }
+]