/usr/include/colord-1/colorhug/ch-common.h is in libcolorhug-dev 1.2.12-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 | /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Copyright (C) 2011-2015 Richard Hughes <richard@hughsie.com>
*
* Licensed under the GNU General Public License Version 2
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#if !defined (__COLORHUG_H_INSIDE__) && !defined (CH_COMPILATION)
#error "Only <colorhug.h> can be included directly."
#endif
#ifndef CH_COMMON_H
#define CH_COMMON_H
#include <glib.h>
#include <gusb.h>
G_BEGIN_DECLS
/* device constants */
#define CH_USB_VID 0x273f
#define CH_USB_PID_BOOTLOADER 0x1000
#define CH_USB_PID_BOOTLOADER2 0x1005
#define CH_USB_PID_BOOTLOADER_ALS 0x1006 /* since 1.2.9 */
#define CH_USB_PID_BOOTLOADER_PLUS 0x1003
#define CH_USB_PID_FIRMWARE 0x1001
#define CH_USB_PID_FIRMWARE2 0x1004
#define CH_USB_PID_FIRMWARE_ALS 0x1007 /* since 1.2.9 */
#define CH_USB_PID_FIRMWARE_ALS_SENSOR_HID 0x1008 /* since 1.2.11 */
#define CH_USB_PID_FIRMWARE_PLUS 0x1002
#define CH_USB_CONFIG 0x0001
#define CH_USB_INTERFACE 0x0000
#define CH_USB_HID_EP 0x01
#define CH_USB_HID_EP_IN (CH_USB_HID_EP | 0x80)
#define CH_USB_HID_EP_OUT (CH_USB_HID_EP | 0x00)
#define CH_USB_HID_EP_SIZE 64
/* old device constants */
#define CH_USB_VID_LEGACY 0x04d8
#define CH_USB_PID_LEGACY 0xf8da
/* the default timeout in client tools */
#define CH_DEVICE_USB_TIMEOUT 10000 /* ms */
/* constants for ownership tags */
#define CH_OWNER_LENGTH_MAX 60
/**
* CH_CMD_GET_COLOR_SELECT:
*
* Get the color select state.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][1:color_select]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ×
* ColorHugALS | × | ✓
*
* Since: 0.1.29
**/
#define CH_CMD_GET_COLOR_SELECT 0x01
/**
* CH_CMD_SET_COLOR_SELECT:
*
* Set the color select state.
*
* IN: [1:cmd][1:color_select]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ×
* ColorHugALS | × | ✓
*
* Since: 0.1.29
**/
#define CH_CMD_SET_COLOR_SELECT 0x02
/**
* CH_CMD_GET_MULTIPLIER:
*
* Gets the multiplier value.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][1:multiplier_value]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ×
* ColorHugALS | × | ✓
*
* Since: 0.1.29
**/
#define CH_CMD_GET_MULTIPLIER 0x03
/**
* CH_CMD_SET_MULTIPLIER:
*
* Sets the multiplier value.
*
* IN: [1:cmd][1:multiplier_value]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ×
* ColorHugALS | × | ✓
*
* Since: 0.1.29
**/
#define CH_CMD_SET_MULTIPLIER 0x04
/**
* CH_CMD_GET_INTEGRAL_TIME:
*
* Gets the integral time.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][2:integral_time]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ✓
* ColorHugALS | × | ✓
*
* Since: 0.1.29
**/
#define CH_CMD_GET_INTEGRAL_TIME 0x05
/**
* CH_CMD_SET_INTEGRAL_TIME:
*
* Sets the integral time.
*
* IN: [1:cmd][2:integral_time]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ✓
* ColorHugALS | × | ✓
*
* Since: 0.1.29
**/
#define CH_CMD_SET_INTEGRAL_TIME 0x06
/**
* CH_CMD_GET_FIRMWARE_VERSION:
*
* Gets the firmware version.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][2:major][2:minor][2:micro]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | ✓ | ✓
* ColorHug2 | ✓ | ✓
* ColorHug+ | ✓ | ✓
* ColorHugALS | ✓ | ✓
*
* Since: 0.1.29
**/
#define CH_CMD_GET_FIRMWARE_VERSION 0x07
/**
* CH_CMD_GET_CALIBRATION:
*
* Gets the calibration matrix. The description does not have to be NULL
* terminated.
*
* @types is a bitmask which corresponds to:
*
* bit:
* 0 Can be used with LCD panels
* 1 Can be used with CRT monitors
* 2 Can be used with projectors
* 3 Can be used with LED panels
* 4-7 Reserved for future use
*
* IN: [1:cmd][2:index]
* OUT: [1:retval][1:cmd][2*9:matrix_value][1:types][23:description]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ×
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_GET_CALIBRATION 0x09
/**
* CH_CMD_SET_CALIBRATION:
*
* Sets the calibration matrix.
*
* IN: [1:cmd][2:index][4*9:matrix_value][1:types][23:description]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ×
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_SET_CALIBRATION 0x0a
/**
* CH_CMD_GET_SERIAL_NUMBER:
*
* Gets the device serial number.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][4:serial_number]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ✓
*
* Since: 0.1.29
**/
#define CH_CMD_GET_SERIAL_NUMBER 0x0b
/**
* CH_CMD_SET_SERIAL_NUMBER:
*
* Sets the device serial number.
*
* IN: [1:cmd][4:serial_number]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_SET_SERIAL_NUMBER 0x0c
/**
* CH_CMD_GET_LEDS:
*
* Get the LED state.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][1:led_state]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | ✓ | ✓
*
* Since: 0.1.29
**/
#define CH_CMD_GET_LEDS 0x0d
/**
* CH_CMD_SET_LEDS:
*
* Set the LED state. Using a @repeat value of anything other than
* 0 will block the processor for the duration of the command.
*
* If @repeat is not 0, then the LEDs are reset to all off at the end
* of the sequence.
*
* IN: [1:cmd][1:led_state][1:repeat][1:on-time][1:off-time]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ✓
*
* Since: 0.1.29
**/
#define CH_CMD_SET_LEDS 0x0e
/**
* CH_CMD_GET_DARK_OFFSETS:
*
* Get the dark offsets.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][2:red][2:green][2:blue]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_GET_DARK_OFFSETS 0x0f
/**
* CH_CMD_SET_DARK_OFFSETS:
*
* Set the dark offsets for use when taking samples when the measure
* mode is FREQUENCY. When the measure mode is DURATION these values
* have no effect.
*
* IN: [1:cmd][2:red][2:green][2:blue]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_SET_DARK_OFFSETS 0x10
/**
* CH_CMD_GET_OWNER_NAME:
*
* Get User's Name
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][60:owner-name]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_GET_OWNER_NAME 0x11
/**
* CH_CMD_SET_OWNER_NAME:
*
* Set User's Name
*
* IN: [1:cmd][60:owner-name]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_SET_OWNER_NAME 0x12
/**
* CH_CMD_GET_OWNER_EMAIL:
*
* Get User's Email Address
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][60:owner-email]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_GET_OWNER_EMAIL 0x13
/**
* CH_CMD_SET_OWNER_EMAIL:
*
* Set User's Email Address
*
* IN: [1:cmd][60:owner-email]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_SET_OWNER_EMAIL 0x14
/**
* CH_CMD_WRITE_EEPROM:
*
* Write values to EEPROM.
*
* IN: [1:cmd][8:eeprom_magic]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_WRITE_EEPROM 0x20
/**
* CH_CMD_TAKE_READING_RAW:
*
* Take a raw reading.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][4:count]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ✓
* ColorHugALS | × | ✓
*
* Since: 0.1.29
**/
#define CH_CMD_TAKE_READING_RAW 0x21
/**
* CH_CMD_TAKE_READINGS:
*
* Take a reading taking into account just dark offsets.
* All of @red, @green and @blue are packed float values.
*
* This command is useful if you want to do an ambient reading.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][4:red][4:green][4:blue]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_TAKE_READINGS 0x22
/**
* CH_CMD_TAKE_READING_XYZ:
*
* Take a reading taking into account:
* 1. dark offsets
* 2. the calibration matrix
*
* If the calibration index > %CH_CALIBRATION_MAX then the calibration
* map is used to find the default calibration index to use.
*
* If the calibration index is set to %CH_CALIBRATION_SPECTRAL then the
* spectral hardware is used if it is available. The CIE 1931 luminosity
* function data is used by default.
*
* IN: [1:cmd][2:calibration-index]
* OUT: [1:retval][1:cmd][4:red][4:green][4:blue]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_TAKE_READING_XYZ 0x23
/**
* CH_CMD_TAKE_READING_SPECTRAL:
*
* Takes a spectral reading putting %CH_CCD_SPECTRAL_RESOLUTION uint16_t values
* (typically 7296 bytes) in SRAM.
* The values are scaled from 0x0000 to 0x03ff and correspond to the actual
* signal amplitude once Vref- and Vref+ have been taken into account.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][4:addr]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ×
* ColorHug2 | × | ×
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.31
**/
#define CH_CMD_TAKE_READING_SPECTRAL 0x50
/**
* CH_CMD_GET_ADC_CALIBRATION_POS:
*
* Gets the value of the Vref+ ADC adjustment.
* @vref is a packed float.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][4:vref]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ×
* ColorHug2 | × | ×
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.31
**/
#define CH_CMD_GET_ADC_CALIBRATION_POS 0x51
/**
* CH_CMD_GET_ADC_CALIBRATION_NEG:
*
* Gets the value of the Vref- ADC adjustment.
* @vref is a packed float.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][4:vref]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ×
* ColorHug2 | × | ×
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.31
**/
#define CH_CMD_GET_ADC_CALIBRATION_NEG 0x52
/**
* CH_CMD_GET_CCD_CALIBRATION:
*
* Gets the spectral indexes for the RGB calibration which are values between 0
* and %CH_CCD_SPECTRAL_RESOLUTION pointing to the dominant peak for the color.
* Red is nominally 625nm, green 520nm and blue 465nm.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][2:red-idx][2:green-idx][2:blue-idx]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ×
* ColorHug2 | × | ×
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.31
**/
#define CH_CMD_GET_CCD_CALIBRATION 0x53
/**
* CH_CMD_SET_CCD_CALIBRATION:
*
* Sets the spectral indexes for the RGB calibration.
*
* IN: [1:cmd][2:red-idx][2:green-idx][2:blue-idx]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ×
* ColorHug2 | × | ×
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.31
**/
#define CH_CMD_SET_CCD_CALIBRATION 0x54
/**
* CH_CMD_RESET:
*
* Reset the processor.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd] (but with success the device will disconnect)
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | ✓ | ✓
* ColorHug2 | ✓ | ✓
* ColorHug+ | ✓ | ✓
* ColorHugALS | ✓ | ✓
*
* Since: 0.1.29
**/
#define CH_CMD_RESET 0x24
/**
* CH_CMD_READ_FLASH:
*
* Read in raw data from the flash memory.
*
* IN: [1:cmd][2:address][1:length]
* OUT: [1:retval][1:cmd][1:checksum][1-60:data]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | ✓ | ×
* ColorHug2 | ✓ | ×
* ColorHug+ | ✓ | ×
* ColorHugALS | ✓ | ×
*
* Since: 0.1.29
**/
#define CH_CMD_READ_FLASH 0x25
/**
* CH_CMD_ERASE_FLASH:
*
* Erases flash memory before a write is done.
* Erasing flash can only be done in 1k byte chunks and should be
* aligned to 1k.
*
* IN: [1:cmd][2:address][2:length]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | ✓ | ×
* ColorHug2 | ✓ | ×
* ColorHug+ | ✓ | ×
* ColorHugALS | ✓ | ×
*
* Since: 0.1.29
**/
#define CH_CMD_ERASE_FLASH 0x29
/**
* CH_CMD_WRITE_FLASH:
*
* Write raw data to the flash memory. You can only write aligned to
* a 32 byte boundary, and you must flush any incomplete 64 byte block.
*
* IN: [1:cmd][2:address][1:length][1:checksum][1-32:data]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | ✓ | ×
* ColorHug2 | ✓ | ×
* ColorHug+ | ✓ | ×
* ColorHugALS | ✓ | ×
*
* Since: 0.1.29
**/
#define CH_CMD_WRITE_FLASH 0x26
/**
* CH_CMD_BOOT_FLASH:
*
* Boot into to the flash memory.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | ✓ | ×
* ColorHug2 | ✓ | ×
* ColorHug+ | ✓ | ×
* ColorHugALS | ✓ | ×
*
* Since: 0.1.29
**/
#define CH_CMD_BOOT_FLASH 0x27
/**
* CH_CMD_SET_FLASH_SUCCESS:
*
* Sets the result of the firmware flashing. The idea of this command
* is that the flashing interaction is thus:
*
* 1. Reset() device goes to bootloader mode
* 2. SetFlashSuccess(FALSE)
* 3. WriteFlash($data)
* 4. ReadFlash($data) to verify
* 5. BootFlash() switch to program mode
* 6. SetFlashSuccess(TRUE)
*
* The idea is that we only set the success FALSE from the bootoloader
* to indicate that on booting we should not boot into the program.
* We can only set the success true from the *new* program code so as
* to verify that the new program boots, and can accept HID commands.
*
* IN: [1:cmd][1:success]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | ✓ | ✓
* ColorHug2 | ✓ | ✓
* ColorHug+ | ✓ | ✓
* ColorHugALS | ✓ | ✓
*
* Different values of @success are permitted in each mode.
*
* Since: 0.1.29
**/
#define CH_CMD_SET_FLASH_SUCCESS 0x28
/**
* CH_CMD_GET_PRE_SCALE:
*
* Get the pre XYZ scaling constant. @scale is a packed float.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][4:scale]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ×
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_GET_PRE_SCALE 0x2c
/**
* CH_CMD_SET_PRE_SCALE:
*
* Set the pre XYZ scaling constant. @scale is a packed float.
*
* IN: [1:cmd][4:scale]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ×
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_SET_PRE_SCALE 0x2d
/**
* CH_CMD_GET_POST_SCALE:
*
* Get the post XYZ scaling constant. @scale is a packed float.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][4:scale]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ×
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_GET_POST_SCALE 0x2a
/**
* CH_CMD_SET_POST_SCALE:
*
* Set the post XYZ scaling constant. @scale is a packed float.
*
* IN: [1:cmd][4:scale]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ×
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_SET_POST_SCALE 0x2b
/**
* CH_CMD_GET_CALIBRATION_MAP:
*
* Get the mappings from default calibration type to calibration
* indexes.
*
* The calibration types are as follows:
* LCD = 0
* CRT = 1
* Projector = 2
* LED = 3
* Custom1 = 4
* Custom2 = 5
*
* In the future CustomX may be renamed to another display technology,
* e.g. e-ink.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][6*2:types]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ×
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_GET_CALIBRATION_MAP 0x2e
/**
* CH_CMD_SET_CALIBRATION_MAP:
*
* Set the calibration type to index map.
*
* IN: [1:cmd][6*2:types]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ×
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_SET_CALIBRATION_MAP 0x2f
/**
* CH_CMD_GET_HARDWARE_VERSION:
*
* Get the hardware version.
*
* The hardware versions are as follows:
* 0x00 = Pre-production hardware
* 0x01 = ColorHug
* 0x02 = ColorHug2
* 0x03 = ColorHug+
* 0x04 = ColorHugALS
* 0x05-0x0f = Reserved for future use
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][1:hw_version]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | ✓ | ✓
* ColorHug2 | ✓ | ✓
* ColorHug+ | ✓ | ✓
* ColorHugALS | ✓ | ✓
*
* Since: 0.1.29
**/
#define CH_CMD_GET_HARDWARE_VERSION 0x30
/**
* CH_CMD_TAKE_READING_ARRAY:
*
* Takes 30 raw samples and returns them in an array.
*
* This command can be used to find the optimum delay between patches
* by showing a black sample area, then white, and then using this
* command to find out how long the actual hardware delay is.
*
* It can also be used to find out how stable the device or output is
* over a small amount of time, typically ~2.5 seconds for the maximum
* integral time.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][30:reading_array]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ×
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_TAKE_READING_ARRAY 0x31
/**
* CH_CMD_SET_PCB_ERRATA:
*
* Sets the board errata value. Board errata is used to correct swapped
* LEDs and any future problems discovered that only affect some batches
* of hardware version 1.
*
* The errata bitmask is as follows:
* 0x00 = No errata for this PCB
* 0x01 = Leds are swapped
* 0x02-0xffff = Reserved for future use
*
* IN: [1:cmd][2:pcb_errata]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_SET_PCB_ERRATA 0x32
/**
* CH_CMD_GET_PCB_ERRATA:
*
* Gets the board errata value.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][2:pcb_errata]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_GET_PCB_ERRATA 0x33
/**
* CH_CMD_SET_REMOTE_HASH:
*
* Sets the remote SHA1 hash of the profile. This is designed to
* be used by the calibration program to indicate the key which allows
* the completed profile to be found from a public web service.
*
* IN: [1:cmd][20:sha1_hash]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_SET_REMOTE_HASH 0x34
/**
* CH_CMD_GET_REMOTE_HASH:
*
* Gets the remote hash which is used to get the last profile saved
* to a public web service.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][20:sha1_hash]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_GET_REMOTE_HASH 0x35
/**
* CH_CMD_SET_MEASURE_MODE:
*
* Sets the measurement mode. The mode can either be frequency or pulse
* duration. The former is well tested, but the latter is much more
* precise.
*
* IN: [1:cmd][1:measure_mode]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ×
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_SET_MEASURE_MODE 0x36
/**
* CH_CMD_GET_MEASURE_MODE:
*
* Gets the measurement mode.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][1:measure_mode]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ✓
* ColorHug2 | × | ×
* ColorHug+ | × | ×
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_GET_MEASURE_MODE 0x37
/**
* CH_CMD_READ_SRAM:
*
* Read in raw data from the SRAM memory.
*
* IN: [1:cmd][2:address][1:length]
* OUT: [1:retval][1:cmd][1-60:data]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ×
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_READ_SRAM 0x38
/**
* CH_CMD_WRITE_SRAM:
*
* Write raw data to the SRAM memory.
*
* IN: [1:cmd][2:address][1:length][1-60:data]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ×
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_WRITE_SRAM 0x39
/**
* CH_CMD_GET_TEMPERATURE:
*
* Gets the temperature of the sensor in degrees celsius
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][4:temperature]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ×
* ColorHug2 | × | ✓
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 0.1.29
**/
#define CH_CMD_GET_TEMPERATURE 0x3b
/**
* CH_CMD_GET_DAC_VALUE:
*
* Get the DAC value. @scale is a packed float, where 1.0f is 3.3V
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd][4:value]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ×
* ColorHug2 | × | ×
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 1.1.6
**/
#define CH_CMD_GET_DAC_VALUE 0x3c
/**
* CH_CMD_SET_DAC_VALUE:
*
* Set the DAC value. @scale is a packed float, where 1.0f is 3.3V
*
* IN: [1:cmd][4:value]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | × | ×
* ColorHug2 | × | ×
* ColorHug+ | × | ✓
* ColorHugALS | × | ×
*
* Since: 1.1.6
**/
#define CH_CMD_SET_DAC_VALUE 0x3d
/**
* CH_CMD_SELF_TEST:
*
* Tests the device by trying to get a non-zero reading from each
* color channel.
*
* IN: [1:cmd]
* OUT: [1:retval][1:cmd]
*
* This command is available under these conditions:
*
* | Bootloader | Firmware
* ---------------+--------------+-----------
* ColorHug | ✓ | ✓
* ColorHug2 | ✓ | ✓
* ColorHug+ | ✓ | ✓
* ColorHugALS | ✓ | ×
*
* Since: 0.1.29
**/
#define CH_CMD_SELF_TEST 0x40
/* secret code */
#define CH_WRITE_EEPROM_MAGIC "Un1c0rn2"
#define CH_FIRMWARE_ID_TOKEN1 "40338ceb"
#define CH_FIRMWARE_ID_TOKEN2 "2082b5e0"
#define CH_FIRMWARE_ID_TOKEN_ALS "84f40464" /* since 1.2.9 */
#define CH_FIRMWARE_ID_TOKEN_PLUS "6d6f05a9"
#define CH_DEVICE_GUID_COLORHUG "40338ceb-b966-4eae-adae-9c32edfcc484" /* since 1.2.9 */
#define CH_DEVICE_GUID_COLORHUG2 "2082b5e0-7a64-478a-b1b2-e3404fab6dad" /* since 1.2.9 */
#define CH_DEVICE_GUID_COLORHUG_ALS "84f40464-9272-4ef7-9399-cd95f12da696" /* since 1.2.9 */
#define CH_DEVICE_GUID_COLORHUG_PLUS "6d6f05a9-3ecb-43a2-bcbb-3844f1825366" /* since 1.2.9 */
/* input and output buffer offsets */
#define CH_BUFFER_INPUT_CMD 0x00
#define CH_BUFFER_INPUT_DATA 0x01
#define CH_BUFFER_OUTPUT_RETVAL 0x00
#define CH_BUFFER_OUTPUT_CMD 0x01
#define CH_BUFFER_OUTPUT_DATA 0x02
/* where the custom firmware is stored */
#define CH_EEPROM_ADDR_RUNCODE 0x4000
#define CH_EEPROM_ADDR_RUNCODE_ALS 0x2000 /* since 1.2.9 */
/* the number of useful samples from the the CCD */
#define CH_CCD_SPECTRAL_RESOLUTION 3648
/* although each calibration can be stored in 60 bytes,
* we use a full 64 byte block */
#define CH_CALIBRATION_MAX 64 /* so finishes at device params */
#define CH_CALIBRATION_SPECTRAL 0xffff
#define CH_CALIBRATION_DESCRIPTION_LEN 23 /* 60 - (9*4) - 1 */
/* the supported calibration types bitfield */
#define CH_CALIBRATION_TYPE_LCD 0x01
#define CH_CALIBRATION_TYPE_CRT 0x02
#define CH_CALIBRATION_TYPE_PROJECTOR 0x04
#define CH_CALIBRATION_TYPE_LED 0x08
#define CH_CALIBRATION_TYPE_ALL 0xff
/* approximate sample times */
#define CH_INTEGRAL_TIME_VALUE_5MS 0x0300
#define CH_INTEGRAL_TIME_VALUE_50MS 0x1f00
#define CH_INTEGRAL_TIME_VALUE_100MS 0x3a00
#define CH_INTEGRAL_TIME_VALUE_200MS 0x7500
#define CH_INTEGRAL_TIME_VALUE_MAX 0xffff
/* flash constants */
#define CH_FLASH_ERASE_BLOCK_SIZE 0x400 /* 1024 */
#define CH_FLASH_WRITE_BLOCK_SIZE 0x040 /* 64 */
#define CH_FLASH_TRANSFER_BLOCK_SIZE 0x020 /* 32 */
#define CH_FLASH_RECONNECT_TIMEOUT 5000 /* ms */
/* calibration remapping contants */
#define CH_CALIBRATION_INDEX_FACTORY_ONLY 0x00
#define CH_CALIBRATION_INDEX_LCD (CH_CALIBRATION_MAX + 0)
#define CH_CALIBRATION_INDEX_CRT (CH_CALIBRATION_MAX + 1)
#define CH_CALIBRATION_INDEX_PROJECTOR (CH_CALIBRATION_MAX + 2)
#define CH_CALIBRATION_INDEX_LED (CH_CALIBRATION_MAX + 3)
#define CH_CALIBRATION_INDEX_MAX 0x06
/* which color to select */
typedef enum {
CH_COLOR_SELECT_RED,
CH_COLOR_SELECT_WHITE,
CH_COLOR_SELECT_BLUE,
CH_COLOR_SELECT_GREEN
} ChColorSelect;
/* Led colors: possible bitfield values */
typedef enum {
CH_STATUS_LED_GREEN = 1 << 0,
CH_STATUS_LED_RED = 1 << 1,
CH_STATUS_LED_BLUE = 1 << 2 /* Since: 0.1.29 */
} ChStatusLed;
/* what frequency divider to use */
typedef enum {
CH_FREQ_SCALE_0,
CH_FREQ_SCALE_20,
CH_FREQ_SCALE_2,
CH_FREQ_SCALE_100
} ChFreqScale;
/* fatal error morse code */
typedef enum {
CH_ERROR_NONE,
CH_ERROR_UNKNOWN_CMD,
CH_ERROR_WRONG_UNLOCK_CODE,
CH_ERROR_NOT_IMPLEMENTED,
CH_ERROR_UNDERFLOW_SENSOR,
CH_ERROR_NO_SERIAL,
CH_ERROR_WATCHDOG,
CH_ERROR_INVALID_ADDRESS,
CH_ERROR_INVALID_LENGTH,
CH_ERROR_INVALID_CHECKSUM,
CH_ERROR_INVALID_VALUE,
CH_ERROR_UNKNOWN_CMD_FOR_BOOTLOADER,
CH_ERROR_NO_CALIBRATION,
CH_ERROR_OVERFLOW_MULTIPLY,
CH_ERROR_OVERFLOW_ADDITION,
CH_ERROR_OVERFLOW_SENSOR,
CH_ERROR_OVERFLOW_STACK,
CH_ERROR_DEVICE_DEACTIVATED,
CH_ERROR_INCOMPLETE_REQUEST,
CH_ERROR_SELF_TEST_SENSOR,
CH_ERROR_SELF_TEST_RED,
CH_ERROR_SELF_TEST_GREEN,
CH_ERROR_SELF_TEST_BLUE,
CH_ERROR_SELF_TEST_COLOR_SELECT,
CH_ERROR_SELF_TEST_MULTIPLIER,
CH_ERROR_INVALID_CALIBRATION,
CH_ERROR_SRAM_FAILED,
CH_ERROR_OUT_OF_MEMORY,
CH_ERROR_SELF_TEST_TEMPERATURE,
CH_ERROR_SELF_TEST_I2C,
CH_ERROR_SELF_TEST_ADC_VDD,
CH_ERROR_SELF_TEST_ADC_VSS,
CH_ERROR_SELF_TEST_ADC_VREF,
CH_ERROR_I2C_SLAVE_ADDRESS,
CH_ERROR_I2C_SLAVE_CONFIG,
CH_ERROR_SELF_TEST_EEPROM, /* since 1.2.9 */
/*< private >*/
CH_ERROR_LAST
} ChError;
/* the measure mode */
typedef enum {
CH_MEASURE_MODE_FREQUENCY,
CH_MEASURE_MODE_DURATION
} ChMeasureMode;
/* any problems with the PCB */
typedef enum {
CH_PCB_ERRATA_NONE = 0,
CH_PCB_ERRATA_SWAPPED_LEDS = 1 << 0,
CH_PCB_ERRATA_NO_WELCOME = 1 << 1,
/*< private >*/
CH_PCB_ERRATA_LAST = 1 << 2
} ChPcbErrata;
typedef enum {
CH_DEVICE_MODE_UNKNOWN,
CH_DEVICE_MODE_LEGACY,
CH_DEVICE_MODE_BOOTLOADER,
CH_DEVICE_MODE_FIRMWARE,
CH_DEVICE_MODE_BOOTLOADER_PLUS,
CH_DEVICE_MODE_FIRMWARE_PLUS,
CH_DEVICE_MODE_FIRMWARE2, /* since 1.2.2 */
CH_DEVICE_MODE_BOOTLOADER2, /* since 1.2.3 */
CH_DEVICE_MODE_BOOTLOADER_ALS, /* since 1.2.9 */
CH_DEVICE_MODE_FIRMWARE_ALS, /* since 1.2.9 */
/*< private >*/
CH_DEVICE_MODE_LAST
} ChDeviceMode;
/* prototypes */
const gchar *ch_strerror (ChError error_enum);
const gchar *ch_command_to_string (guint8 cmd);
const gchar *ch_multiplier_to_string (ChFreqScale multiplier);
const gchar *ch_color_select_to_string (ChColorSelect color_select);
const gchar *ch_measure_mode_to_string (ChMeasureMode measure_mode);
const gchar *ch_device_mode_to_string (ChDeviceMode device_mode);
ChDeviceMode ch_device_mode_from_firmware (const guint8 *data,
gsize data_len);
G_END_DECLS
#endif
|