Spaces:
Running
Running
File size: 41,873 Bytes
6ce4ca6 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 |
import {
PortHandler,
PacketHandler,
COMM_SUCCESS,
COMM_RX_TIMEOUT,
COMM_RX_CORRUPT,
COMM_TX_FAIL,
COMM_NOT_AVAILABLE,
SCS_LOBYTE,
SCS_HIBYTE,
SCS_MAKEWORD,
GroupSyncRead, // Import GroupSyncRead
GroupSyncWrite // Import GroupSyncWrite
} from "./lowLevelSDK.mjs";
// Import address constants from the correct file
import {
ADDR_SCS_PRESENT_POSITION,
ADDR_SCS_GOAL_POSITION,
ADDR_SCS_TORQUE_ENABLE,
ADDR_SCS_GOAL_ACC,
ADDR_SCS_GOAL_SPEED
} from "./scsservo_constants.mjs";
// Import debug logging function
import { debugLog } from "./debug.mjs";
// Define constants not present in scsservo_constants.mjs
const ADDR_SCS_MODE = 33;
const ADDR_SCS_LOCK = 55;
const ADDR_SCS_ID = 5; // Address for Servo ID
const ADDR_SCS_BAUD_RATE = 6; // Address for Baud Rate
// Module-level variables for handlers
let portHandler = null;
let packetHandler = null;
/**
* Unified Servo SDK with flexible locking control
* Supports both locked (respects servo locks) and unlocked (temporary unlock) operations
*/
/**
* Connects to the serial port and initializes handlers.
* @param {object} [options] - Connection options.
* @param {number} [options.baudRate=1000000] - The baud rate for the serial connection.
* @param {number} [options.protocolEnd=0] - The protocol end setting (0 for STS/SMS, 1 for SCS).
* @returns {Promise<true>} Resolves with true on successful connection.
* @throws {Error} If connection fails or port cannot be opened/selected.
*/
export async function connect(options = {}) {
if (portHandler && portHandler.isOpen) {
debugLog("Already connected to servo system.");
return true;
}
const { baudRate = 1000000, protocolEnd = 0 } = options;
try {
portHandler = new PortHandler();
const portRequested = await portHandler.requestPort();
if (!portRequested) {
portHandler = null;
throw new Error("Failed to select a serial port.");
}
portHandler.setBaudRate(baudRate);
const portOpened = await portHandler.openPort();
if (!portOpened) {
await portHandler.closePort().catch(console.error);
portHandler = null;
throw new Error(`Failed to open port at baudrate ${baudRate}.`);
}
packetHandler = new PacketHandler(protocolEnd);
debugLog(`Connected to servo system at ${baudRate} baud, protocol end: ${protocolEnd}.`);
return true;
} catch (err) {
console.error("Error during servo connection:", err);
if (portHandler) {
try {
await portHandler.closePort();
} catch (closeErr) {
console.error("Error closing port after connection failure:", closeErr);
}
}
portHandler = null;
packetHandler = null;
throw new Error(`Servo connection failed: ${err.message}`);
}
}
/**
* Disconnects from the serial port.
* @returns {Promise<true>} Resolves with true on successful disconnection.
* @throws {Error} If disconnection fails.
*/
export async function disconnect() {
if (!portHandler || !portHandler.isOpen) {
debugLog("Already disconnected from servo system.");
return true;
}
try {
await portHandler.closePort();
portHandler = null;
packetHandler = null;
debugLog("Disconnected from servo system.");
return true;
} catch (err) {
console.error("Error during servo disconnection:", err);
portHandler = null;
packetHandler = null;
throw new Error(`Servo disconnection failed: ${err.message}`);
}
}
/**
* Checks if the SDK is currently connected.
* @returns {boolean} True if connected, false otherwise.
*/
export function isConnected() {
return !!(portHandler && portHandler.isOpen && packetHandler);
}
/**
* Checks if the SDK is connected. Throws an error if not.
* @throws {Error} If not connected.
*/
function checkConnection() {
if (!portHandler || !packetHandler) {
throw new Error("Not connected to servo system. Call connect() first.");
}
}
// =============================================================================
// SERVO LOCKING OPERATIONS
// =============================================================================
/**
* Locks a servo to prevent configuration changes.
* @param {number} servoId - The ID of the servo (1-252).
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, write fails, or an exception occurs.
*/
export async function lockServo(servoId) {
checkConnection();
try {
debugLog(`🔒 Locking servo ${servoId}...`);
const [result, error] = await packetHandler.write1ByteTxRx(
portHandler,
servoId,
ADDR_SCS_LOCK,
1
);
if (result !== COMM_SUCCESS) {
throw new Error(
`Error locking servo ${servoId}: ${packetHandler.getTxRxResult(result)}, Error: ${error}`
);
}
debugLog(`🔒 Servo ${servoId} locked successfully`);
return "success";
} catch (err) {
console.error(`Exception locking servo ${servoId}:`, err);
throw new Error(`Failed to lock servo ${servoId}: ${err.message}`);
}
}
/**
* Unlocks a servo to allow configuration changes.
* @param {number} servoId - The ID of the servo (1-252).
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, write fails, or an exception occurs.
*/
export async function unlockServo(servoId) {
checkConnection();
try {
debugLog(`🔓 Unlocking servo ${servoId}...`);
const [result, error] = await packetHandler.write1ByteTxRx(
portHandler,
servoId,
ADDR_SCS_LOCK,
0
);
if (result !== COMM_SUCCESS) {
throw new Error(
`Error unlocking servo ${servoId}: ${packetHandler.getTxRxResult(result)}, Error: ${error}`
);
}
debugLog(`🔓 Servo ${servoId} unlocked successfully`);
return "success";
} catch (err) {
console.error(`Exception unlocking servo ${servoId}:`, err);
throw new Error(`Failed to unlock servo ${servoId}: ${err.message}`);
}
}
/**
* Locks multiple servos sequentially.
* @param {number[]} servoIds - Array of servo IDs to lock.
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If any servo fails to lock.
*/
export async function lockServos(servoIds) {
checkConnection();
debugLog(`🔒 Locking ${servoIds.length} servos: [${servoIds.join(', ')}]`);
// Lock servos sequentially to avoid port conflicts
for (const servoId of servoIds) {
await lockServo(servoId);
}
debugLog(`🔒 All ${servoIds.length} servos locked successfully`);
return "success";
}
/**
* Locks servos for production use by both locking configuration and enabling torque.
* This ensures servos are truly locked and controlled by the system.
* @param {number[]} servoIds - Array of servo IDs to lock for production.
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If any servo fails to lock or enable torque.
*/
export async function lockServosForProduction(servoIds) {
checkConnection();
debugLog(`🔒 Locking ${servoIds.length} servos for production use: [${servoIds.join(', ')}]`);
// Lock servos sequentially and enable torque for each
for (const servoId of servoIds) {
try {
debugLog(`🔒 Locking servo ${servoId} for production...`);
// 1. Lock the servo configuration
const [lockResult, lockError] = await packetHandler.write1ByteTxRx(
portHandler,
servoId,
ADDR_SCS_LOCK,
1
);
if (lockResult !== COMM_SUCCESS) {
throw new Error(`Error locking servo ${servoId}: ${packetHandler.getTxRxResult(lockResult)}, Error: ${lockError}`);
}
// 2. Enable torque to make servo controllable
const [torqueResult, torqueError] = await packetHandler.write1ByteTxRx(
portHandler,
servoId,
ADDR_SCS_TORQUE_ENABLE,
1
);
if (torqueResult !== COMM_SUCCESS) {
console.warn(`Warning: Failed to enable torque for servo ${servoId}: ${packetHandler.getTxRxResult(torqueResult)}, Error: ${torqueError}`);
// Don't throw here, locking is more important than torque enable
}
debugLog(`🔒 Servo ${servoId} locked and torque enabled for production`);
} catch (err) {
console.error(`Exception locking servo ${servoId} for production:`, err);
throw new Error(`Failed to lock servo ${servoId} for production: ${err.message}`);
}
}
debugLog(`🔒 All ${servoIds.length} servos locked for production successfully`);
return "success";
}
/**
* Unlocks multiple servos sequentially.
* @param {number[]} servoIds - Array of servo IDs to unlock.
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If any servo fails to unlock.
*/
export async function unlockServos(servoIds) {
checkConnection();
debugLog(`🔓 Unlocking ${servoIds.length} servos: [${servoIds.join(', ')}]`);
// Unlock servos sequentially to avoid port conflicts
for (const servoId of servoIds) {
await unlockServo(servoId);
}
debugLog(`🔓 All ${servoIds.length} servos unlocked successfully`);
return "success";
}
/**
* Safely unlocks servos for manual movement by unlocking configuration and disabling torque.
* This is the safest way to leave servos when disconnecting/cleaning up.
* @param {number[]} servoIds - Array of servo IDs to unlock safely.
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If any servo fails to unlock or disable torque.
*/
export async function unlockServosForManualMovement(servoIds) {
checkConnection();
debugLog(`🔓 Safely unlocking ${servoIds.length} servos for manual movement: [${servoIds.join(', ')}]`);
// Unlock servos sequentially and disable torque for each
for (const servoId of servoIds) {
try {
debugLog(`🔓 Safely unlocking servo ${servoId} for manual movement...`);
// 1. Disable torque first (makes servo freely movable)
const [torqueResult, torqueError] = await packetHandler.write1ByteTxRx(
portHandler,
servoId,
ADDR_SCS_TORQUE_ENABLE,
0
);
if (torqueResult !== COMM_SUCCESS) {
console.warn(`Warning: Failed to disable torque for servo ${servoId}: ${packetHandler.getTxRxResult(torqueResult)}, Error: ${torqueError}`);
// Continue anyway, unlocking is more important
}
// 2. Unlock the servo configuration
const [unlockResult, unlockError] = await packetHandler.write1ByteTxRx(
portHandler,
servoId,
ADDR_SCS_LOCK,
0
);
if (unlockResult !== COMM_SUCCESS) {
throw new Error(`Error unlocking servo ${servoId}: ${packetHandler.getTxRxResult(unlockResult)}, Error: ${unlockError}`);
}
debugLog(`🔓 Servo ${servoId} safely unlocked - torque disabled and configuration unlocked`);
} catch (err) {
console.error(`Exception safely unlocking servo ${servoId}:`, err);
throw new Error(`Failed to safely unlock servo ${servoId}: ${err.message}`);
}
}
debugLog(`🔓 All ${servoIds.length} servos safely unlocked for manual movement`);
return "success";
}
// =============================================================================
// READ OPERATIONS (No locking needed)
// =============================================================================
/**
* Reads the current position of a servo.
* @param {number} servoId - The ID of the servo (1-252).
* @returns {Promise<number>} Resolves with the position (0-4095).
* @throws {Error} If not connected, read fails, or an exception occurs.
*/
export async function readPosition(servoId) {
checkConnection();
try {
const [position, result, error] = await packetHandler.read2ByteTxRx(
portHandler,
servoId,
ADDR_SCS_PRESENT_POSITION
);
if (result !== COMM_SUCCESS) {
throw new Error(
`Error reading position from servo ${servoId}: ${packetHandler.getTxRxResult(
result
)}, Error code: ${error}`
);
}
return position & 0xffff;
} catch (err) {
console.error(`Exception reading position from servo ${servoId}:`, err);
throw new Error(`Exception reading position from servo ${servoId}: ${err.message}`);
}
}
/**
* Reads the current baud rate index of a servo.
* @param {number} servoId - The ID of the servo (1-252).
* @returns {Promise<number>} Resolves with the baud rate index (0-7).
* @throws {Error} If not connected, read fails, or an exception occurs.
*/
export async function readBaudRate(servoId) {
checkConnection();
try {
const [baudIndex, result, error] = await packetHandler.read1ByteTxRx(
portHandler,
servoId,
ADDR_SCS_BAUD_RATE
);
if (result !== COMM_SUCCESS) {
throw new Error(
`Error reading baud rate from servo ${servoId}: ${packetHandler.getTxRxResult(
result
)}, Error code: ${error}`
);
}
return baudIndex;
} catch (err) {
console.error(`Exception reading baud rate from servo ${servoId}:`, err);
throw new Error(`Exception reading baud rate from servo ${servoId}: ${err.message}`);
}
}
/**
* Reads the current operating mode of a servo.
* @param {number} servoId - The ID of the servo (1-252).
* @returns {Promise<number>} Resolves with the mode (0 for position, 1 for wheel).
* @throws {Error} If not connected, read fails, or an exception occurs.
*/
export async function readMode(servoId) {
checkConnection();
try {
const [modeValue, result, error] = await packetHandler.read1ByteTxRx(
portHandler,
servoId,
ADDR_SCS_MODE
);
if (result !== COMM_SUCCESS) {
throw new Error(
`Error reading mode from servo ${servoId}: ${packetHandler.getTxRxResult(
result
)}, Error code: ${error}`
);
}
return modeValue;
} catch (err) {
console.error(`Exception reading mode from servo ${servoId}:`, err);
throw new Error(`Exception reading mode from servo ${servoId}: ${err.message}`);
}
}
/**
* Reads the current position of multiple servos synchronously.
* @param {number[]} servoIds - An array of servo IDs (1-252) to read from.
* @returns {Promise<Map<number, number>>} Resolves with a Map where keys are servo IDs and values are positions (0-4095).
* @throws {Error} If not connected or transmission fails completely.
*/
export async function syncReadPositions(servoIds) {
checkConnection();
if (!Array.isArray(servoIds) || servoIds.length === 0) {
debugLog("Sync Read: No servo IDs provided.");
return new Map();
}
const startAddress = ADDR_SCS_PRESENT_POSITION;
const dataLength = 2;
const groupSyncRead = new GroupSyncRead(portHandler, packetHandler, startAddress, dataLength);
const positions = new Map();
const validIds = [];
// Add parameters for each valid servo ID
servoIds.forEach((id) => {
if (id >= 1 && id <= 252) {
if (groupSyncRead.addParam(id)) {
validIds.push(id);
} else {
console.warn(`Sync Read: Failed to add param for servo ID ${id} (maybe duplicate or invalid).`);
}
} else {
console.warn(`Sync Read: Invalid servo ID ${id} skipped.`);
}
});
if (validIds.length === 0) {
debugLog("Sync Read: No valid servo IDs to read.");
return new Map();
}
try {
let txResult = await groupSyncRead.txPacket();
if (txResult !== COMM_SUCCESS) {
throw new Error(`Sync Read txPacket failed: ${packetHandler.getTxRxResult(txResult)}`);
}
let rxResult = await groupSyncRead.rxPacket();
if (rxResult !== COMM_SUCCESS) {
console.warn(`Sync Read rxPacket overall result: ${packetHandler.getTxRxResult(rxResult)}. Checking individual servos.`);
}
const failedIds = [];
validIds.forEach((id) => {
const isAvailable = groupSyncRead.isAvailable(id, startAddress, dataLength);
if (isAvailable) {
const position = groupSyncRead.getData(id, startAddress, dataLength);
positions.set(id, position & 0xffff);
} else {
failedIds.push(id);
}
});
if (failedIds.length > 0) {
console.warn(`Sync Read: Data not available for servo IDs: ${failedIds.join(", ")}. Got ${positions.size}/${validIds.length} servos successfully.`);
}
return positions;
} catch (err) {
console.error("Exception during syncReadPositions:", err);
throw new Error(`Sync Read failed: ${err.message}`);
}
}
// =============================================================================
// WRITE OPERATIONS - LOCKED MODE (Respects servo locks)
// =============================================================================
/**
* Writes a target position to a servo (respects locks).
* Will fail if the servo is locked.
* @param {number} servoId - The ID of the servo (1-252).
* @param {number} position - The target position value (0-4095).
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, position is out of range, write fails, or an exception occurs.
*/
export async function writePosition(servoId, position) {
checkConnection();
try {
if (position < 0 || position > 4095) {
throw new Error(`Invalid position value ${position} for servo ${servoId}. Must be between 0 and 4095.`);
}
const targetPosition = Math.round(position);
const [result, error] = await packetHandler.write2ByteTxRx(
portHandler,
servoId,
ADDR_SCS_GOAL_POSITION,
targetPosition
);
if (result !== COMM_SUCCESS) {
throw new Error(`Error writing position to servo ${servoId}: ${packetHandler.getTxRxResult(result)}, Error code: ${error}`);
}
return "success";
} catch (err) {
console.error(`Exception writing position to servo ${servoId}:`, err);
throw new Error(`Failed to write position to servo ${servoId}: ${err.message}`);
}
}
/**
* Enables or disables the torque of a servo (respects locks).
* @param {number} servoId - The ID of the servo (1-252).
* @param {boolean} enable - True to enable torque, false to disable.
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, write fails, or an exception occurs.
*/
export async function writeTorqueEnable(servoId, enable) {
checkConnection();
try {
const enableValue = enable ? 1 : 0;
const [result, error] = await packetHandler.write1ByteTxRx(
portHandler,
servoId,
ADDR_SCS_TORQUE_ENABLE,
enableValue
);
if (result !== COMM_SUCCESS) {
throw new Error(`Error setting torque for servo ${servoId}: ${packetHandler.getTxRxResult(result)}, Error code: ${error}`);
}
return "success";
} catch (err) {
console.error(`Exception setting torque for servo ${servoId}:`, err);
throw new Error(`Exception setting torque for servo ${servoId}: ${err.message}`);
}
}
// =============================================================================
// WRITE OPERATIONS - UNLOCKED MODE (Temporary unlock for operation)
// =============================================================================
/**
* Helper to attempt locking a servo, logging errors without throwing.
* @param {number} servoId
*/
async function tryLockServo(servoId) {
try {
await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_LOCK, 1);
} catch (lockErr) {
console.error(`Failed to re-lock servo ${servoId}:`, lockErr);
}
}
/**
* Writes a target position to a servo with temporary unlocking.
* Temporarily unlocks the servo, writes the position, then locks it back.
* @param {number} servoId - The ID of the servo (1-252).
* @param {number} position - The target position value (0-4095).
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, position is out of range, write fails, or an exception occurs.
*/
export async function writePositionUnlocked(servoId, position) {
checkConnection();
let unlocked = false;
try {
if (position < 0 || position > 4095) {
throw new Error(`Invalid position value ${position} for servo ${servoId}. Must be between 0 and 4095.`);
}
const targetPosition = Math.round(position);
debugLog(`🔓 Temporarily unlocking servo ${servoId} for position write...`);
// 1. Unlock servo configuration first
const [resUnlock, errUnlock] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_LOCK, 0);
if (resUnlock !== COMM_SUCCESS) {
debugLog(`Warning: Failed to unlock servo ${servoId}, trying direct write anyway...`);
} else {
unlocked = true;
}
// 2. Write the position
const [result, error] = await packetHandler.write2ByteTxRx(portHandler, servoId, ADDR_SCS_GOAL_POSITION, targetPosition);
if (result !== COMM_SUCCESS) {
throw new Error(`Error writing position to servo ${servoId}: ${packetHandler.getTxRxResult(result)}, Error code: ${error}`);
}
// 3. Lock servo configuration back
if (unlocked) {
const [resLock, errLock] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_LOCK, 1);
if (resLock !== COMM_SUCCESS) {
console.warn(`Warning: Failed to re-lock servo ${servoId} after position write: ${packetHandler.getTxRxResult(resLock)}, Error: ${errLock}`);
} else {
unlocked = false;
}
}
return "success";
} catch (err) {
console.error(`Exception writing position to servo ${servoId}:`, err);
if (unlocked) {
await tryLockServo(servoId);
}
throw new Error(`Failed to write position to servo ${servoId}: ${err.message}`);
}
}
/**
* Writes a target position and disables torque for manual movement.
* @param {number} servoId - The ID of the servo (1-252).
* @param {number} position - The target position value (0-4095).
* @param {number} waitTimeMs - Time to wait for servo to reach position (milliseconds).
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, position is out of range, write fails, or an exception occurs.
*/
export async function writePositionAndDisableTorque(servoId, position, waitTimeMs = 1500) {
checkConnection();
let unlocked = false;
try {
if (position < 0 || position > 4095) {
throw new Error(`Invalid position value ${position} for servo ${servoId}. Must be between 0 and 4095.`);
}
const targetPosition = Math.round(position);
debugLog(`🔓 Moving servo ${servoId} to position ${targetPosition}, waiting ${waitTimeMs}ms, then disabling torque...`);
// 1. Unlock servo configuration first
const [resUnlock, errUnlock] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_LOCK, 0);
if (resUnlock !== COMM_SUCCESS) {
debugLog(`Warning: Failed to unlock servo ${servoId}, trying direct write anyway...`);
} else {
unlocked = true;
}
// 2. Enable torque first
const [torqueEnableResult, torqueEnableError] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_TORQUE_ENABLE, 1);
if (torqueEnableResult !== COMM_SUCCESS) {
console.warn(`Warning: Failed to enable torque for servo ${servoId}: ${packetHandler.getTxRxResult(torqueEnableResult)}, Error: ${torqueEnableError}`);
} else {
debugLog(`✅ Torque enabled for servo ${servoId}`);
}
// 3. Write the position
const [result, error] = await packetHandler.write2ByteTxRx(portHandler, servoId, ADDR_SCS_GOAL_POSITION, targetPosition);
if (result !== COMM_SUCCESS) {
throw new Error(`Error writing position to servo ${servoId}: ${packetHandler.getTxRxResult(result)}, Error code: ${error}`);
}
// 4. Wait for servo to reach position
debugLog(`⏳ Waiting ${waitTimeMs}ms for servo ${servoId} to reach position ${targetPosition}...`);
await new Promise(resolve => setTimeout(resolve, waitTimeMs));
// 5. Disable torque
const [torqueResult, torqueError] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_TORQUE_ENABLE, 0);
if (torqueResult !== COMM_SUCCESS) {
console.warn(`Warning: Failed to disable torque for servo ${servoId}: ${packetHandler.getTxRxResult(torqueResult)}, Error: ${torqueError}`);
} else {
debugLog(`✅ Torque disabled for servo ${servoId} - now movable by hand`);
}
// 6. Lock servo configuration back
if (unlocked) {
const [resLock, errLock] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_LOCK, 1);
if (resLock !== COMM_SUCCESS) {
console.warn(`Warning: Failed to re-lock servo ${servoId} after position write: ${packetHandler.getTxRxResult(resLock)}, Error: ${errLock}`);
} else {
unlocked = false;
}
}
return "success";
} catch (err) {
console.error(`Exception writing position and disabling torque for servo ${servoId}:`, err);
if (unlocked) {
await tryLockServo(servoId);
}
throw new Error(`Failed to write position and disable torque for servo ${servoId}: ${err.message}`);
}
}
/**
* Enables or disables the torque of a servo with temporary unlocking.
* @param {number} servoId - The ID of the servo (1-252).
* @param {boolean} enable - True to enable torque, false to disable.
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, write fails, or an exception occurs.
*/
export async function writeTorqueEnableUnlocked(servoId, enable) {
checkConnection();
let unlocked = false;
try {
const enableValue = enable ? 1 : 0;
debugLog(`🔓 Temporarily unlocking servo ${servoId} for torque enable write...`);
// 1. Unlock servo configuration first
const [resUnlock, errUnlock] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_LOCK, 0);
if (resUnlock !== COMM_SUCCESS) {
debugLog(`Warning: Failed to unlock servo ${servoId}, trying direct write anyway...`);
} else {
unlocked = true;
}
// 2. Write the torque enable
const [result, error] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_TORQUE_ENABLE, enableValue);
if (result !== COMM_SUCCESS) {
throw new Error(`Error setting torque for servo ${servoId}: ${packetHandler.getTxRxResult(result)}, Error code: ${error}`);
}
// 3. Lock servo configuration back
if (unlocked) {
const [resLock, errLock] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_LOCK, 1);
if (resLock !== COMM_SUCCESS) {
console.warn(`Warning: Failed to re-lock servo ${servoId} after torque enable write: ${packetHandler.getTxRxResult(resLock)}, Error: ${errLock}`);
} else {
unlocked = false;
}
}
return "success";
} catch (err) {
console.error(`Exception setting torque for servo ${servoId}:`, err);
if (unlocked) {
await tryLockServo(servoId);
}
throw new Error(`Exception setting torque for servo ${servoId}: ${err.message}`);
}
}
// =============================================================================
// SYNC WRITE OPERATIONS
// =============================================================================
/**
* Writes target positions to multiple servos synchronously.
* @param {Map<number, number> | object} servoPositions - A Map or object where keys are servo IDs (1-252) and values are target positions (0-4095).
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, any position is out of range, transmission fails, or an exception occurs.
*/
export async function syncWritePositions(servoPositions) {
checkConnection();
const groupSyncWrite = new GroupSyncWrite(portHandler, packetHandler, ADDR_SCS_GOAL_POSITION, 2);
let paramAdded = false;
const entries = servoPositions instanceof Map ? servoPositions.entries() : Object.entries(servoPositions);
for (const [idStr, position] of entries) {
const servoId = parseInt(idStr, 10);
if (isNaN(servoId) || servoId < 1 || servoId > 252) {
throw new Error(`Invalid servo ID "${idStr}" in syncWritePositions.`);
}
if (position < 0 || position > 4095) {
throw new Error(`Invalid position value ${position} for servo ${servoId} in syncWritePositions. Must be between 0 and 4095.`);
}
const targetPosition = Math.round(position);
const data = [SCS_LOBYTE(targetPosition), SCS_HIBYTE(targetPosition)];
if (groupSyncWrite.addParam(servoId, data)) {
paramAdded = true;
} else {
console.warn(`Failed to add servo ${servoId} to sync write group (possibly duplicate).`);
}
}
if (!paramAdded) {
debugLog("Sync Write: No valid servo positions provided or added.");
return "success";
}
try {
const result = await groupSyncWrite.txPacket();
if (result !== COMM_SUCCESS) {
throw new Error(`Sync Write txPacket failed: ${packetHandler.getTxRxResult(result)}`);
}
return "success";
} catch (err) {
console.error("Exception during syncWritePositions:", err);
throw new Error(`Sync Write failed: ${err.message}`);
}
}
/**
* Writes a target speed for a servo in wheel mode.
* @param {number} servoId - The ID of the servo
* @param {number} speed - The target speed value (-10000 to 10000). Negative values indicate reverse direction. 0 stops the wheel.
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, either write fails, or an exception occurs.
*/
export async function writeWheelSpeed(servoId, speed) {
checkConnection();
let unlocked = false;
try {
const clampedSpeed = Math.max(-10000, Math.min(10000, Math.round(speed)));
let speedValue = Math.abs(clampedSpeed) & 0x7fff;
if (clampedSpeed < 0) {
speedValue |= 0x8000;
}
debugLog(`Temporarily unlocking servo ${servoId} for wheel speed write...`);
// 1. Unlock servo configuration first
const [resUnlock, errUnlock] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_LOCK, 0);
if (resUnlock !== COMM_SUCCESS) {
debugLog(`Warning: Failed to unlock servo ${servoId}, trying direct write anyway...`);
} else {
unlocked = true;
}
// 2. Write the speed
const [result, error] = await packetHandler.write2ByteTxRx(portHandler, servoId, ADDR_SCS_GOAL_SPEED, speedValue);
if (result !== COMM_SUCCESS) {
throw new Error(`Error writing wheel speed to servo ${servoId}: ${packetHandler.getTxRxResult(result)}, Error: ${error}`);
}
// 3. Lock servo configuration back
if (unlocked) {
const [resLock, errLock] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_LOCK, 1);
if (resLock !== COMM_SUCCESS) {
console.warn(`Warning: Failed to re-lock servo ${servoId} after wheel speed write: ${packetHandler.getTxRxResult(resLock)}, Error: ${errLock}`);
} else {
unlocked = false;
}
}
return "success";
} catch (err) {
console.error(`Exception writing wheel speed to servo ${servoId}:`, err);
if (unlocked) {
await tryLockServo(servoId);
}
throw new Error(`Exception writing wheel speed to servo ${servoId}: ${err.message}`);
}
}
/**
* Writes target speeds to multiple servos in wheel mode synchronously.
* @param {Map<number, number> | object} servoSpeeds - A Map or object where keys are servo IDs (1-252) and values are target speeds (-10000 to 10000).
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, any speed is out of range, transmission fails, or an exception occurs.
*/
export async function syncWriteWheelSpeed(servoSpeeds) {
checkConnection();
const groupSyncWrite = new GroupSyncWrite(
portHandler,
packetHandler,
ADDR_SCS_GOAL_SPEED,
2 // Data length for speed (2 bytes)
);
let paramAdded = false;
const entries = servoSpeeds instanceof Map ? servoSpeeds.entries() : Object.entries(servoSpeeds);
// Second pass: Add valid parameters
for (const [idStr, speed] of entries) {
const servoId = parseInt(idStr, 10); // Already validated
if (isNaN(servoId) || servoId < 1 || servoId > 252) {
throw new Error(`Invalid servo ID "${idStr}" in syncWriteWheelSpeed.`);
}
if (speed < -10000 || speed > 10000) {
throw new Error(
`Invalid speed value ${speed} for servo ${servoId} in syncWriteWheelSpeed. Must be between -10000 and 10000.`
);
}
const clampedSpeed = Math.max(-10000, Math.min(10000, Math.round(speed))); // Ensure integer, already validated range
let speedValue = Math.abs(clampedSpeed) & 0x7fff; // Get absolute value, ensure within 15 bits
// Set the direction bit (MSB of the 16-bit value) if speed is negative
if (clampedSpeed < 0) {
speedValue |= 0x8000; // Set the 16th bit for reverse direction
}
const data = [SCS_LOBYTE(speedValue), SCS_HIBYTE(speedValue)];
if (groupSyncWrite.addParam(servoId, data)) {
paramAdded = true;
} else {
// This should ideally not happen if IDs are unique, but handle defensively
console.warn(
`Failed to add servo ${servoId} to sync write speed group (possibly duplicate).`
);
}
}
if (!paramAdded) {
debugLog("Sync Write Speed: No valid servo speeds provided or added.");
return "success"; // Nothing to write is considered success
}
try {
// Send the Sync Write instruction
const result = await groupSyncWrite.txPacket();
if (result !== COMM_SUCCESS) {
throw new Error(`Sync Write Speed txPacket failed: ${packetHandler.getTxRxResult(result)}`);
}
return "success";
} catch (err) {
console.error("Exception during syncWriteWheelSpeed:", err);
// Re-throw the original error or a new one wrapping it
throw new Error(`Sync Write Speed failed: ${err.message}`);
}
}
/**
* Sets the Baud Rate of a servo.
* NOTE: After changing the baud rate, you might need to disconnect and reconnect
* at the new baud rate to communicate with the servo further.
* @param {number} servoId - The current ID of the servo to configure (1-252).
* @param {number} baudRateIndex - The index representing the new baud rate (0-7).
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, input is invalid, any step fails, or an exception occurs.
*/
export async function setBaudRate(servoId, baudRateIndex) {
checkConnection();
// Validate inputs
if (servoId < 1 || servoId > 252) {
throw new Error(`Invalid servo ID provided: ${servoId}. Must be between 1 and 252.`);
}
if (baudRateIndex < 0 || baudRateIndex > 7) {
throw new Error(`Invalid baudRateIndex: ${baudRateIndex}. Must be between 0 and 7.`);
}
let unlocked = false;
try {
debugLog(`Setting baud rate for servo ${servoId}: Index=${baudRateIndex}`);
// 1. Unlock servo configuration
const [resUnlock, errUnlock] = await packetHandler.write1ByteTxRx(
portHandler,
servoId,
ADDR_SCS_LOCK,
0 // 0 to unlock
);
if (resUnlock !== COMM_SUCCESS) {
throw new Error(
`Failed to unlock servo ${servoId}: ${packetHandler.getTxRxResult(
resUnlock
)}, Error: ${errUnlock}`
);
}
unlocked = true;
// 2. Write new Baud Rate index
const [resBaud, errBaud] = await packetHandler.write1ByteTxRx(
portHandler,
servoId,
ADDR_SCS_BAUD_RATE,
baudRateIndex
);
if (resBaud !== COMM_SUCCESS) {
throw new Error(
`Failed to write baud rate index ${baudRateIndex} to servo ${servoId}: ${packetHandler.getTxRxResult(
resBaud
)}, Error: ${errBaud}`
);
}
// 3. Lock servo configuration
const [resLock, errLock] = await packetHandler.write1ByteTxRx(
portHandler,
servoId,
ADDR_SCS_LOCK,
1
);
if (resLock !== COMM_SUCCESS) {
throw new Error(
`Failed to lock servo ${servoId} after setting baud rate: ${packetHandler.getTxRxResult(
resLock
)}, Error: ${errLock}.`
);
}
unlocked = false; // Successfully locked
debugLog(
`Successfully set baud rate for servo ${servoId}. Index: ${baudRateIndex}. Remember to potentially reconnect with the new baud rate.`
);
return "success";
} catch (err) {
console.error(`Exception during setBaudRate for servo ID ${servoId}:`, err);
if (unlocked) {
await tryLockServo(servoId);
}
throw new Error(`Failed to set baud rate for servo ${servoId}: ${err.message}`);
}
}
/**
* Sets the ID of a servo.
* NOTE: Changing the ID requires using the new ID for subsequent commands.
* @param {number} currentServoId - The current ID of the servo to configure (1-252).
* @param {number} newServoId - The new ID to set for the servo (1-252).
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, input is invalid, any step fails, or an exception occurs.
*/
export async function setServoId(currentServoId, newServoId) {
checkConnection();
// Validate inputs
if (currentServoId < 1 || currentServoId > 252 || newServoId < 1 || newServoId > 252) {
throw new Error(
`Invalid servo ID provided. Current: ${currentServoId}, New: ${newServoId}. Must be between 1 and 252.`
);
}
if (currentServoId === newServoId) {
debugLog(`Servo ID is already ${newServoId}. No change needed.`);
return "success";
}
let unlocked = false;
let idWritten = false;
try {
debugLog(`Setting servo ID: From ${currentServoId} to ${newServoId}`);
// 1. Unlock servo configuration (using current ID)
const [resUnlock, errUnlock] = await packetHandler.write1ByteTxRx(
portHandler,
currentServoId,
ADDR_SCS_LOCK,
0 // 0 to unlock
);
if (resUnlock !== COMM_SUCCESS) {
throw new Error(
`Failed to unlock servo ${currentServoId}: ${packetHandler.getTxRxResult(
resUnlock
)}, Error: ${errUnlock}`
);
}
unlocked = true;
// 2. Write new Servo ID (using current ID)
const [resId, errId] = await packetHandler.write1ByteTxRx(
portHandler,
currentServoId,
ADDR_SCS_ID,
newServoId
);
if (resId !== COMM_SUCCESS) {
throw new Error(
`Failed to write new ID ${newServoId} to servo ${currentServoId}: ${packetHandler.getTxRxResult(
resId
)}, Error: ${errId}`
);
}
idWritten = true;
// 3. Lock servo configuration (using NEW ID)
const [resLock, errLock] = await packetHandler.write1ByteTxRx(
portHandler,
newServoId, // Use NEW ID here
ADDR_SCS_LOCK,
1 // 1 to lock
);
if (resLock !== COMM_SUCCESS) {
// ID was likely changed, but lock failed. Critical state.
throw new Error(
`Failed to lock servo with new ID ${newServoId}: ${packetHandler.getTxRxResult(
resLock
)}, Error: ${errLock}. Configuration might be incomplete.`
);
}
unlocked = false; // Successfully locked with new ID
debugLog(
`Successfully set servo ID from ${currentServoId} to ${newServoId}. Remember to use the new ID for future commands.`
);
return "success";
} catch (err) {
console.error(`Exception during setServoId for current ID ${currentServoId}:`, err);
if (unlocked) {
// If unlock succeeded but subsequent steps failed, attempt to re-lock.
// If ID write failed, use current ID. If ID write succeeded but lock failed, use new ID.
const idToLock = idWritten ? newServoId : currentServoId;
console.warn(`Attempting to re-lock servo using ID ${idToLock}...`);
await tryLockServo(idToLock);
}
throw new Error(
`Failed to set servo ID from ${currentServoId} to ${newServoId}: ${err.message}`
);
}
}
// =============================================================================
// LEGACY COMPATIBILITY FUNCTIONS (for backward compatibility)
// =============================================================================
/**
* Sets a servo to wheel mode (continuous rotation) with unlocking.
* @param {number} servoId - The ID of the servo (1-252).
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, any step fails, or an exception occurs.
*/
export async function setWheelMode(servoId) {
checkConnection();
let unlocked = false;
try {
debugLog(`Setting servo ${servoId} to wheel mode...`);
// 1. Unlock servo configuration
const [resUnlock, errUnlock] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_LOCK, 0);
if (resUnlock !== COMM_SUCCESS) {
throw new Error(`Failed to unlock servo ${servoId}: ${packetHandler.getTxRxResult(resUnlock)}, Error: ${errUnlock}`);
}
unlocked = true;
// 2. Set mode to 1 (Wheel/Speed mode)
const [resMode, errMode] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_MODE, 1);
if (resMode !== COMM_SUCCESS) {
throw new Error(`Failed to set wheel mode for servo ${servoId}: ${packetHandler.getTxRxResult(resMode)}, Error: ${errMode}`);
}
// 3. Lock servo configuration
const [resLock, errLock] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_LOCK, 1);
if (resLock !== COMM_SUCCESS) {
throw new Error(`Failed to lock servo ${servoId} after setting mode: ${packetHandler.getTxRxResult(resLock)}, Error: ${errLock}`);
}
unlocked = false;
debugLog(`Successfully set servo ${servoId} to wheel mode.`);
return "success";
} catch (err) {
console.error(`Exception setting wheel mode for servo ${servoId}:`, err);
if (unlocked) {
await tryLockServo(servoId);
}
throw new Error(`Failed to set wheel mode for servo ${servoId}: ${err.message}`);
}
}
/**
* Sets a servo back to position control mode from wheel mode.
* @param {number} servoId - The ID of the servo (1-252).
* @returns {Promise<"success">} Resolves with "success".
* @throws {Error} If not connected, any step fails, or an exception occurs.
*/
export async function setPositionMode(servoId) {
checkConnection();
let unlocked = false;
try {
debugLog(`Setting servo ${servoId} back to position mode...`);
// 1. Unlock servo configuration
const [resUnlock, errUnlock] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_LOCK, 0);
if (resUnlock !== COMM_SUCCESS) {
throw new Error(`Failed to unlock servo ${servoId}: ${packetHandler.getTxRxResult(resUnlock)}, Error: ${errUnlock}`);
}
unlocked = true;
// 2. Set mode to 0 (Position/Servo mode)
const [resMode, errMode] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_MODE, 0);
if (resMode !== COMM_SUCCESS) {
throw new Error(`Failed to set position mode for servo ${servoId}: ${packetHandler.getTxRxResult(resMode)}, Error: ${errMode}`);
}
// 3. Lock servo configuration
const [resLock, errLock] = await packetHandler.write1ByteTxRx(portHandler, servoId, ADDR_SCS_LOCK, 1);
if (resLock !== COMM_SUCCESS) {
throw new Error(`Failed to lock servo ${servoId} after setting mode: ${packetHandler.getTxRxResult(resLock)}, Error: ${errLock}`);
}
unlocked = false;
debugLog(`Successfully set servo ${servoId} back to position mode.`);
return "success";
} catch (err) {
console.error(`Exception setting position mode for servo ${servoId}:`, err);
if (unlocked) {
await tryLockServo(servoId);
}
throw new Error(`Failed to set position mode for servo ${servoId}: ${err.message}`);
}
}
|