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
|
/*
* Argyll Color Management System
*
* Gretag i1Monitor & i1Pro related functions
*/
/*
* Author: Graeme W. Gill
* Date: 24/11/2006
*
* Copyright 2006 - 2014, Graeme W. Gill
* All rights reserved.
*
* This material is licenced under the GNU GENERAL PUBLIC LICENSE Version 2 or later :-
* see the License2.txt file for licencing details.
*/
/*
If you make use of the instrument driver code here, please note
that it is the author(s) of the code who are responsibility
for its operation. Any problems or queries regarding driving
instruments with the Argyll drivers, should be directed to
the Argyll's author(s), and not to any other party.
If there is some instrument feature or function that you
would like supported here, it is recommended that you
contact Argyll's author(s) first, rather than attempt to
modify the software yourself, if you don't have firm knowledge
of the instrument communicate protocols. There is a chance
that an instrument could be damaged by an incautious command
sequence, and the instrument companies generally cannot and
will not support developers that they have not qualified
and agreed to support.
*/
/*
TTBD
There may be a bug in HiRes emissive calibration - if you do an initial
cal. in normal, then switch to HiRes, no white plate cal is performed.
Is it using a previous cal result for this ?
Should add extra filter compensation support.
Should alias projector mode to display mode ??
*/
#include <stdio.h>
#include <stdlib.h>
#include <ctype.h>
#include <string.h>
#include <time.h>
#include <stdarg.h>
#include <math.h>
#ifndef SALONEINSTLIB
#include "copyright.h"
#include "aconfig.h"
#include "numlib.h"
#include "rspl.h"
#else /* SALONEINSTLIB */
#include "sa_config.h"
#include "numsup.h"
#include "rspl1.h"
#endif /* SALONEINSTLIB */
#include "cgats.h"
#include "xspect.h"
#include "insttypes.h"
#include "conv.h"
#include "icoms.h"
#include "i1pro.h"
#include "i1pro_imp.h"
#define MAX_MES_SIZE 500 /* Maximum normal message reply size */
#define MAX_RD_SIZE 5000 /* Maximum reading messagle reply size */
/* Convert a machine specific error code into an abstract inst code */
static inst_code i1pro_interp_code(i1pro *p, i1pro_code ec);
/* ------------------------------------------------------------------------ */
/* Establish communications with a I1DISP */
/* If it's a serial port, use the baud rate given, and timeout in to secs */
/* Return I1PRO_COMS_FAIL on failure to establish communications */
static inst_code
i1pro_init_coms(inst *pp, baud_rate br, flow_control fc, double tout) {
i1pro *p = (i1pro *) pp;
int rsize, se;
icomuflags usbflags = icomuf_none;
#ifdef UNIX_APPLE
/* If the X-Rite software has been installed, then there may */
/* be a daemon process that has the device open. Kill that process off */
/* so that we can open it here, before it re-spawns. */
char *pnames[] = {
// "i1iSisDeviceService",
"i1ProDeviceService",
NULL
};
int retries = 20;
#else /* !UNIX_APPLE */
char **pnames = NULL;
int retries = 0;
#endif /* !UNIX_APPLE */
a1logd(p->log, 2, "i1pro_init_coms: called\n");
if (p->icom->port_type(p->icom) != icomt_usb) {
a1logd(p->log, 1, "i1pro_init_coms: wrong communications type for device!\n");
return inst_coms_fail;
}
a1logd(p->log, 2, "i1pro_init_coms: about to init USB\n");
/* Set config, interface, write end point, read end point, read quanta */
/* ("serial" end points aren't used - the i1display uses USB control messages) */
if ((se = p->icom->set_usb_port(p->icom, 1, 0x00, 0x00, usbflags, retries, pnames))
!= ICOM_OK) {
a1logd(p->log, 1, "i1pro_init_coms: failed ICOM err 0x%x\n",se);
return i1pro_interp_code(p, icoms2i1pro_err(se));
}
a1logd(p->log, 2, "i1pro_init_coms: init coms has succeeded\n");
p->gotcoms = 1;
return inst_ok;
}
static inst_code
i1pro_determine_capabilities(i1pro *p) {
i1proimp *m = (i1proimp *)p->m;
i1pro_state *s = m != NULL ? &m->ms[m->mmode] : NULL;
/* Set the base Monitor/Pro capabilities mask */
p->cap = inst_mode_emis_spot
| inst_mode_emis_tele
| inst_mode_emis_strip /* Also likely to be light table reading */
| inst_mode_trans_spot /* Support this manually using a light table */
| inst_mode_trans_strip
| inst_mode_emis_nonadaptive
| inst_mode_colorimeter
| inst_mode_spectral
;
/* Set the Pro capabilities mask */
if (p->dtype == instI1Pro
|| p->dtype == instI1Pro2) {
p->cap |= inst_mode_ref_spot
| inst_mode_ref_strip
;
}
/* Set the Pro2 capabilities mask */
if (p->dtype == instI1Pro2) {
p->cap |= inst_mode_ref_uv
;
}
if (i1pro_imp_highres(p)) /* This is static */
p->cap |= inst_mode_highres;
if (i1pro_imp_ambient(p)) { /* This depends on the instrument */
p->cap |= inst_mode_emis_ambient
| inst_mode_emis_ambient_flash
;
}
p->cap2 = inst2_prog_trig
| inst2_user_trig
| inst2_user_switch_trig
| inst2_bidi_scan
| inst2_has_scan_toll
| inst2_no_feedback
;
if (p->m != NULL) {
i1proimp *m = (i1proimp *)p->m;
i1pro_state *s = &m->ms[m->mmode];
if (s->emiss) {
p->cap2 |= inst2_meas_disp_update;
p->cap2 |= inst2_emis_refr_meas;
}
}
if (s != NULL && s->reflective) {
if (m->capabilities2 & I1PRO_CAP2_UV_FILT)
p->cap3 = inst3_filter_UVCut;
else
p->cap3 = inst3_filter_none;
}
return inst_ok;
}
/* Initialise the I1PRO */
/* return non-zero on an error, with inst error code */
static inst_code
i1pro_init_inst(inst *pp) {
i1pro *p = (i1pro *)pp;
i1pro_code ev = I1PRO_OK;
a1logd(p->log, 2, "i1pro_init_inst: called\n");
if (p->gotcoms == 0)
return i1pro_interp_code(p, I1PRO_INT_NO_COMS); /* Must establish coms before calling init */
if ((ev = i1pro_imp_init(p)) != I1PRO_OK) {
a1logd(p->log, 1, "i1pro_init_inst: failed with 0x%x\n",ev);
return i1pro_interp_code(p, ev);
}
p->inited = 1;
a1logd(p->log, 2, "i1pro_init_inst: instrument inited OK\n");
/* Now it's initied, we can get true capabilities */
i1pro_determine_capabilities(p);
return i1pro_interp_code(p, ev);
}
static char *i1pro_get_serial_no(inst *pp) {
i1pro *p = (i1pro *)pp;
if (!pp->gotcoms)
return "";
if (!pp->inited)
return "";
return i1pro_imp_get_serial_no(p);
}
/* Read a set of strips */
static inst_code
i1pro_read_strip(
inst *pp,
char *name, /* Strip name (7 chars) */
int npatch, /* Number of patches in the pass */
char *pname, /* Pass name (3 chars) */
int sguide, /* Guide number */
double pwid, /* Patch length in mm (DTP41) */
double gwid, /* Gap length in mm (DTP41) */
double twid, /* Trailer length in mm (DTP41T) */
ipatch *vals) { /* Pointer to array of instrument patch values */
i1pro *p = (i1pro *)pp;
i1pro_code rv;
if (!p->gotcoms)
return inst_no_coms;
if (!p->inited)
return inst_no_init;
rv = i1pro_imp_measure(p, vals, npatch, instClamp);
return i1pro_interp_code(p, rv);
}
/* Read a single sample */
static inst_code
i1pro_read_sample(
inst *pp,
char *name, /* Strip name (7 chars) */
ipatch *val, /* Pointer to instrument patch value */
instClamping clamp) { /* Clamp XYZ/Lab to be +ve */
i1pro *p = (i1pro *)pp;
i1pro_code rv;
if (!p->gotcoms)
return inst_no_coms;
if (!p->inited)
return inst_no_init;
rv = i1pro_imp_measure(p, val, 1, clamp);
return i1pro_interp_code(p, rv);
}
/* Read an emissive refresh rate */
static inst_code
i1pro_read_refrate(
inst *pp,
double *ref_rate) {
i1pro *p = (i1pro *)pp;
i1pro_code rv;
if (!p->gotcoms)
return inst_no_coms;
if (!p->inited)
return inst_no_init;
if (ref_rate != NULL)
*ref_rate = 0.0;
rv = i1pro_imp_meas_refrate(p, ref_rate);
return i1pro_interp_code(p, rv);
}
/* Read the display update delay */
static inst_code
i1pro_meas_delay(
inst *pp,
int *pdispmsec, /* Return display update delay in msec */
int *pinstmsec) { /* Return instrument reaction time in msec */
i1pro *p = (i1pro *)pp;
i1pro_code rv;
if (!p->gotcoms)
return inst_no_coms;
if (!p->inited)
return inst_no_init;
rv = i1pro_imp_meas_delay(p, pdispmsec, pinstmsec);
return i1pro_interp_code(p, rv);
}
/* Timestamp the white patch change during meas_delay() */
static inst_code i1pro_white_change(
inst *pp,
int init) {
i1pro *p = (i1pro *)pp;
return i1pro_imp_white_change(p, init);
}
/* Return needed and available inst_cal_type's */
static inst_code i1pro_get_n_a_cals(inst *pp, inst_cal_type *pn_cals, inst_cal_type *pa_cals) {
i1pro *p = (i1pro *)pp;
i1pro_code rv;
rv = i1pro_imp_get_n_a_cals(p, pn_cals, pa_cals);
return i1pro_interp_code(p, rv);
}
/* Request an instrument calibration. */
static inst_code i1pro_calibrate(
inst *pp,
inst_cal_type *calt, /* Calibration type to do/remaining */
inst_cal_cond *calc, /* Current condition/desired condition */
inst_calc_id_type *idtype, /* Condition identifier type */
char id[CALIDLEN] /* Condition identifier (ie. white reference ID) */
) {
i1pro *p = (i1pro *)pp;
i1pro_code rv;
if (!p->gotcoms)
return inst_no_coms;
if (!p->inited)
return inst_no_init;
rv = i1pro_imp_calibrate(p, calt, calc, idtype, id);
return i1pro_interp_code(p, rv);
}
/* Instrument specific error codes interpretation */
static char *
i1pro_interp_error(inst *pp, i1pro_code ec) {
// i1pro *p = (i1pro *)pp;
ec &= inst_imask;
switch (ec) {
case I1PRO_INTERNAL_ERROR:
return "Internal software error";
case I1PRO_COMS_FAIL:
return "Communications failure";
case I1PRO_UNKNOWN_MODEL:
return "Not an i1 Pro";
case I1PRO_DATA_PARSE_ERROR:
return "Data from i1 Display didn't parse as expected";
case I1PRO_USER_ABORT:
return "User abort";
case I1PRO_USER_TRIG:
return "User trigger";
case I1PRO_UNSUPPORTED:
return "Unsupported function";
case I1PRO_CAL_SETUP:
return "Calibration retry with correct setup is needed";
case I1PRO_CAL_TRANSWHITEWARN:
return "Transmission white is too low at some wavelengths";
case I1PRO_OK:
return "No device error";
case I1PRO_DATA_COUNT:
return "EEProm data count unexpectedly small";
case I1PRO_DATA_BUFSIZE:
return "EEProm data buffer too small";
case I1PRO_DATA_MAKE_KEY:
return "EEProm data creating key failed";
case I1PRO_DATA_MEMORY:
return "EEProm memory alloc failure";
case I1PRO_DATA_KEYNOTFOUND:
return "EEProm key value wasn't found";
case I1PRO_DATA_WRONGTYPE:
return "EEProm key is the wrong type";
case I1PRO_DATA_KEY_CORRUPT:
return "EEProm key table seems to be corrupted";
case I1PRO_DATA_KEY_COUNT_SMALL:
return "EEProm key table size is too small for expected number of keys";
case I1PRO_DATA_KEY_COUNT_LARGE:
return "EEProm key table size is too large for expected number of keys";
case I1PRO_DATA_KEY_UNKNOWN:
return "EEProm unknown key type";
case I1PRO_DATA_KEY_MEMRANGE:
return "EEProm key data is out of range of EEProm";
case I1PRO_DATA_KEY_ENDMARK:
return "EEProm end section marker was missing";
case I1PRO_HW_HIGHPOWERFAIL:
return "Failed to switch to high power mode";
case I1PRO_HW_EE_SIZE:
return "EEProm size is too small";
case I1PRO_HW_EE_SHORTREAD:
return "Read less bytes for EEProm read than expected";
case I1PRO_HW_EE_SHORTWRITE:
return "Wrote less bytes for EEProm write than expected";
case I1PRO_HW_ME_SHORTREAD:
return "Read less bytes for measurement read than expected";
case I1PRO_HW_ME_ODDREAD:
return "Read a number of bytes not a multiple of 256";
case I1PRO_HW_SW_SHORTREAD:
return "Read less bytes for Switch read than expected";
case I1PRO_HW_LED_SHORTWRITE:
return "Wrote fewer LED sequence bytes than expected";
case I1PRO_HW_UNEX_SPECPARMS:
return "Instrument has unexpected spectral parameters";
case I1PRO_HW_CALIBINFO:
return "Instrument calibration info is missing or corrupted";
case I1PRO_WL_TOOLOW:
return "Wavelength calibration reading is too low";
case I1PRO_WL_SHAPE:
return "Wavelength calibration reading shape is incorrect";
case I1PRO_WL_ERR2BIG:
return "Wavelength calibration correction is excessive";
case I1PRO_RD_DARKREADINCONS:
return "Dark calibration reading is inconsistent";
case I1PRO_RD_SENSORSATURATED:
return "Sensor is saturated";
case I1PRO_RD_DARKNOTVALID:
return "Dark reading is not valid (too light)";
case I1PRO_RD_NEEDS_CAL:
return "Mode needs calibration";
case I1PRO_RD_WHITEREADINCONS:
return "White calibration reading is inconsistent";
case I1PRO_RD_WHITEREFERROR:
return "White reference reading is out of tollerance";
case I1PRO_RD_LIGHTTOOLOW:
return "Light level is too low";
case I1PRO_RD_LIGHTTOOHIGH:
return "Light level is too high";
case I1PRO_RD_SHORTMEAS:
return "Reading is too short";
case I1PRO_RD_READINCONS:
return "Reading is inconsistent";
case I1PRO_RD_TRANSWHITERANGE:
return "Transmission white reference is out of range";
case I1PRO_RD_NOTENOUGHPATCHES:
return "Not enough patches";
case I1PRO_RD_TOOMANYPATCHES:
return "Too many patches";
case I1PRO_RD_NOTENOUGHSAMPLES:
return "Not enough samples per patch - Slow Down!";
case I1PRO_RD_NOFLASHES:
return "No flashes recognized";
case I1PRO_RD_NOAMBB4FLASHES:
return "No ambient found before first flash";
case I1PRO_RD_NOREFR_FOUND:
return "No refresh rate detected or failed to measure it";
case I1PRO_RD_NOTRANS_FOUND:
return "No delay calibration transition found";
case I1PRO_INT_NO_COMS:
return "Communications hasn't been established";
case I1PRO_INT_EETOOBIG:
return "Read of EEProm is too big (> 65536)";
case I1PRO_INT_ODDREADBUF:
return "Measurement read buffer is not a multiple of reading size";
case I1PRO_INT_SMALLREADBUF:
return "Measurement read buffer is too small for initial measurement";
case I1PRO_INT_INTTOOBIG:
return "Integration time is too big";
case I1PRO_INT_INTTOOSMALL:
return "Integration time is too small";
case I1PRO_INT_ILLEGALMODE:
return "Illegal measurement mode selected";
case I1PRO_INT_ZEROMEASURES:
return "Number of measurements requested is zero";
case I1PRO_INT_WRONGPATCHES:
return "Number of patches to match is wrong";
case I1PRO_INT_MEASBUFFTOOSMALL:
return "Measurement exceeded read buffer";
case I1PRO_INT_NOTIMPLEMENTED:
return "Support not implemented";
case I1PRO_INT_NOTCALIBRATED:
return "Unexpectedely invalid calibration";
case I1PRO_INT_NOINTERPDARK:
return "Need interpolated dark and don't have it";
case I1PRO_INT_THREADFAILED:
return "Creation of thread failed";
case I1PRO_INT_BUTTONTIMEOUT:
return "Button status read timed out";
case I1PRO_INT_CIECONVFAIL:
return "Creating spectral to CIE converted failed";
case I1PRO_INT_PREP_LOG_DATA:
return "Error in preparing log data";
case I1PRO_INT_MALLOC:
return "Error in allocating memory";
case I1PRO_INT_CREATE_EEPROM_STORE:
return "Error in creating EEProm store";
case I1PRO_INT_SAVE_SUBT_MODE:
return "Can't save calibration if in subt mode";
case I1PRO_INT_NO_CAL_TO_SAVE:
return "No calibration data to save";
case I1PRO_INT_EEPROM_DATA_MISSING:
return "EEProm data is missing";
case I1PRO_INT_NEW_RSPL_FAILED:
return "Creating RSPL object failed";
case I1PRO_INT_CAL_SAVE:
return "Unable to save calibration to file";
case I1PRO_INT_CAL_RESTORE:
return "Unable to restore calibration from file";
case I1PRO_INT_CAL_TOUCH:
return "Unable to update calibration file modification time";
case I1PRO_INT_ADARK_INVALID:
return "Adaptive dark calibration is invalid";
case I1PRO_INT_NO_HIGH_GAIN:
return "Rev E mode doesn't have a high gain mode";
case I1PRO_INT_ASSERT:
return "Assert fail";
default:
return "Unknown error code";
}
}
/* Convert a machine specific error code into an abstract inst code */
static inst_code
i1pro_interp_code(i1pro *p, i1pro_code ec) {
ec &= inst_imask;
switch (ec) {
case I1PRO_OK:
return inst_ok;
case I1PRO_INTERNAL_ERROR:
return inst_internal_error | ec;
case I1PRO_COMS_FAIL:
return inst_coms_fail | ec;
case I1PRO_UNKNOWN_MODEL:
return inst_unknown_model | ec;
case I1PRO_DATA_PARSE_ERROR:
return inst_protocol_error | ec;
case I1PRO_USER_ABORT:
return inst_user_abort;
case I1PRO_USER_TRIG:
return inst_user_trig;
case I1PRO_UNSUPPORTED:
return inst_unsupported | ec;
case I1PRO_CAL_SETUP:
return inst_cal_setup | ec;
case I1PRO_DATA_COUNT:
case I1PRO_DATA_BUFSIZE:
case I1PRO_DATA_MAKE_KEY:
case I1PRO_DATA_MEMORY:
case I1PRO_DATA_KEYNOTFOUND:
case I1PRO_DATA_WRONGTYPE:
case I1PRO_DATA_KEY_CORRUPT:
case I1PRO_DATA_KEY_COUNT_SMALL:
case I1PRO_DATA_KEY_COUNT_LARGE:
case I1PRO_DATA_KEY_UNKNOWN:
case I1PRO_DATA_KEY_MEMRANGE:
case I1PRO_DATA_KEY_ENDMARK:
case I1PRO_HW_HIGHPOWERFAIL:
case I1PRO_HW_EE_SIZE:
case I1PRO_HW_EE_SHORTREAD:
case I1PRO_HW_EE_SHORTWRITE:
case I1PRO_HW_ME_SHORTREAD:
case I1PRO_HW_ME_ODDREAD:
case I1PRO_HW_SW_SHORTREAD:
case I1PRO_HW_LED_SHORTWRITE:
case I1PRO_HW_UNEX_SPECPARMS:
case I1PRO_HW_CALIBINFO:
case I1PRO_WL_TOOLOW:
case I1PRO_WL_SHAPE:
case I1PRO_WL_ERR2BIG:
return inst_hardware_fail | ec;
case I1PRO_RD_DARKREADINCONS:
case I1PRO_RD_SENSORSATURATED:
case I1PRO_RD_DARKNOTVALID:
case I1PRO_RD_WHITEREADINCONS:
case I1PRO_RD_WHITEREFERROR:
case I1PRO_RD_LIGHTTOOLOW:
case I1PRO_RD_LIGHTTOOHIGH:
case I1PRO_RD_SHORTMEAS:
case I1PRO_RD_READINCONS:
case I1PRO_RD_TRANSWHITERANGE:
case I1PRO_RD_NOTENOUGHPATCHES:
case I1PRO_RD_TOOMANYPATCHES:
case I1PRO_RD_NOTENOUGHSAMPLES:
case I1PRO_RD_NOFLASHES:
case I1PRO_RD_NOAMBB4FLASHES:
case I1PRO_RD_NOREFR_FOUND:
case I1PRO_RD_NOTRANS_FOUND:
return inst_misread | ec;
case I1PRO_RD_NEEDS_CAL:
return inst_needs_cal | ec;
case I1PRO_INT_NO_COMS:
case I1PRO_INT_EETOOBIG:
case I1PRO_INT_ODDREADBUF:
case I1PRO_INT_SMALLREADBUF:
case I1PRO_INT_INTTOOBIG:
case I1PRO_INT_INTTOOSMALL:
case I1PRO_INT_ILLEGALMODE:
case I1PRO_INT_ZEROMEASURES:
case I1PRO_INT_MEASBUFFTOOSMALL:
case I1PRO_INT_NOTIMPLEMENTED:
case I1PRO_INT_NOTCALIBRATED:
case I1PRO_INT_NOINTERPDARK:
case I1PRO_INT_THREADFAILED:
case I1PRO_INT_BUTTONTIMEOUT:
case I1PRO_INT_CIECONVFAIL:
case I1PRO_INT_PREP_LOG_DATA:
case I1PRO_INT_MALLOC:
case I1PRO_INT_CREATE_EEPROM_STORE:
case I1PRO_INT_SAVE_SUBT_MODE:
case I1PRO_INT_NO_CAL_TO_SAVE:
case I1PRO_INT_EEPROM_DATA_MISSING:
case I1PRO_INT_NEW_RSPL_FAILED:
case I1PRO_INT_CAL_SAVE:
case I1PRO_INT_CAL_RESTORE:
case I1PRO_INT_CAL_TOUCH:
case I1PRO_INT_ADARK_INVALID:
case I1PRO_INT_NO_HIGH_GAIN:
case I1PRO_INT_ASSERT:
return inst_internal_error | ec;
}
return inst_other_error | ec;
}
/* Return the instrument capabilities */
static void i1pro_capabilities(inst *pp,
inst_mode *pcap1,
inst2_capability *pcap2,
inst3_capability *pcap3) {
i1pro *p = (i1pro *)pp;
if (pcap1 != NULL)
*pcap1 = p->cap;
if (pcap2 != NULL)
*pcap2 = p->cap2;
if (pcap3 != NULL)
*pcap3 = p->cap3;
}
/* Return the corresponding i1pro measurement mode, */
/* or i1p_no_modes if invalid */
static i1p_mode i1pro_convert_mode(i1pro *p, inst_mode m) {
i1p_mode mmode = 0; /* Instrument measurement mode */
/* Simple test */
if (m & ~p->cap) {
return i1p_no_modes;
}
if (IMODETST(m, inst_mode_ref_spot)) {
mmode = i1p_refl_spot;
} else if (IMODETST(m, inst_mode_ref_strip)) {
mmode = i1p_refl_scan;
} else if (IMODETST(m, inst_mode_trans_spot)) {
mmode = i1p_trans_spot;
} else if (IMODETST(m, inst_mode_trans_strip)) {
mmode = i1p_trans_scan;
} else if (IMODETST(m, inst_mode_emis_spot)
|| IMODETST(m, inst_mode_emis_tele)) {
if (IMODETST(m, inst_mode_emis_nonadaptive))
mmode = i1p_emiss_spot_na;
else
mmode = i1p_emiss_spot;
} else if (IMODETST(m, inst_mode_emis_strip)) {
mmode = i1p_emiss_scan;
} else if (IMODETST(m, inst_mode_emis_ambient)
&& (p->cap & inst_mode_emis_ambient)) {
mmode = i1p_amb_spot;
} else if (IMODETST(m, inst_mode_emis_ambient_flash)
&& (p->cap & inst_mode_emis_ambient_flash)) {
mmode = i1p_amb_flash;
} else {
return i1p_no_modes;
}
return mmode;
}
/* Check device measurement mode */
static inst_code i1pro_check_mode(inst *pp, inst_mode m) {
i1pro *p = (i1pro *)pp;
i1p_mode mmode = 0; /* Instrument measurement mode */
if (!p->gotcoms)
return inst_no_coms;
if (!p->inited)
return inst_no_init;
if (i1pro_convert_mode(p, m) == i1p_no_modes)
return inst_unsupported;
return inst_ok;
}
/* Set device measurement mode */
static inst_code i1pro_set_mode(inst *pp, inst_mode m) {
i1pro *p = (i1pro *)pp;
i1p_mode mmode; /* Instrument measurement mode */
inst_code rv;
if (!p->gotcoms)
return inst_no_coms;
if (!p->inited)
return inst_no_init;
if ((mmode = i1pro_convert_mode(p, m)) == i1p_no_modes)
return inst_unsupported;
if ((rv = i1pro_interp_code(p, i1pro_imp_set_mode(p, mmode, m))) != inst_ok)
return rv;
i1pro_determine_capabilities(p);
return inst_ok;
}
/*
* set or reset an optional mode
*
* Some options talk to the instrument, and these will
* error if it hasn't been initialised.
*/
static inst_code
i1pro_get_set_opt(inst *pp, inst_opt_type m, ...) {
i1pro *p = (i1pro *)pp;
if (m == inst_opt_initcalib) { /* default */
i1pro_set_noinitcalib(p, 0, 0);
return inst_ok;
} else if (m == inst_opt_noinitcalib) {
va_list args;
int losecs = 0;
va_start(args, m);
losecs = va_arg(args, int);
va_end(args);
i1pro_set_noinitcalib(p, 1, losecs);
return inst_ok;
/* Record the trigger mode */
} else if (m == inst_opt_trig_prog
|| m == inst_opt_trig_user
|| m == inst_opt_trig_user_switch) {
i1pro_set_trig(p, m);
return inst_ok;
}
if (m == inst_opt_scan_toll) {
va_list args;
double toll_ratio = 1.0;
va_start(args, m);
toll_ratio = va_arg(args, double);
va_end(args);
return i1pro_interp_code(p, i1pro_set_scan_toll(p, toll_ratio));
}
if (!p->gotcoms)
return inst_no_coms;
if (!p->inited)
return inst_no_init;
/* Not sure if this can be set before init */
if (m == inst_opt_highres) {
return i1pro_interp_code(p, i1pro_set_highres(p));
} else if (m == inst_opt_stdres) {
return i1pro_interp_code(p, i1pro_set_stdres(p));
}
/* Return the filter */
if (m == inst_stat_get_filter) {
i1proimp *imp = (i1proimp *)p->m;
inst_opt_filter *filt;
va_list args;
va_start(args, m);
filt = va_arg(args, inst_opt_filter *);
va_end(args);
*filt = inst_opt_filter_none;
if (imp->physfilt == 0x82)
*filt = inst_opt_filter_UVCut;
return inst_ok;
}
/* Set xcalstd */
if (m == inst_opt_set_xcalstd) {
i1proimp *imp = (i1proimp *)p->m;
xcalstd standard;
va_list args;
va_start(args, m);
standard = va_arg(args, xcalstd);
va_end(args);
imp->target_calstd = standard;
return inst_ok;
}
/* Get the current effective xcalstd */
if (m == inst_opt_get_xcalstd) {
i1proimp *imp = (i1proimp *)p->m;
xcalstd *standard;
va_list args;
va_start(args, m);
standard = va_arg(args, xcalstd *);
va_end(args);
if (imp->target_calstd == xcalstd_native)
*standard = imp->native_calstd; /* If not overridden */
else
*standard = imp->target_calstd; /* Overidden std. */
return inst_ok;
}
if (m == inst_opt_set_custom_filter) {
i1proimp *imp = (i1proimp *)p->m;
va_list args;
xspect *sp = NULL;
va_start(args, m);
sp = va_arg(args, xspect *);
va_end(args);
if (sp == NULL || sp->spec_n == 0) {
imp->custfilt_en = 0;
imp->custfilt.spec_n = 0;
} else {
imp->custfilt_en = 1;
imp->custfilt = *sp; /* Struct copy */
}
return inst_ok;
}
if (m == inst_stat_get_custom_filter) {
i1proimp *imp = (i1proimp *)p->m;
va_list args;
xspect *sp = NULL;
va_start(args, m);
sp = va_arg(args, xspect *);
va_end(args);
if (imp->custfilt_en) {
*sp = imp->custfilt; /* Struct copy */
} else {
sp = NULL;
}
return inst_ok;
}
/* Return the white calibration tile spectrum */
/* (We always return the normal rez. reference values) */
if (m == inst_opt_get_cal_tile_sp) {
i1proimp *imp = (i1proimp *)p->m;
xspect *sp;
inst_code rv;
va_list args;
int i;
va_start(args, m);
sp = va_arg(args, xspect *);
va_end(args);
if (imp->white_ref[0] == NULL)
return inst_no_init;
sp->spec_n = imp->nwav[0];
sp->spec_wl_short = imp->wl_short[0];
sp->spec_wl_long = imp->wl_long[0];
sp->norm = 100.0;
for (i = 0; i < sp->spec_n; i++)
sp->spec[i] = imp->white_ref[0][i] * 100.0;
return inst_ok;
}
/* Lamp drift remediation */
if (m == inst_opt_lamp_remediate) {
i1pro_code ev;
va_list args;
double seconds;
va_start(args, m);
seconds = va_arg(args, double);
va_end(args);
ev = i1pro_imp_lamp_fix(p, seconds);
return i1pro_interp_code(p, ev);
}
/* Use default implementation of other inst_opt_type's */
{
inst_code rv;
va_list args;
va_start(args, m);
rv = inst_get_set_opt_def(pp, m, args);
va_end(args);
return rv;
}
}
/* Destroy ourselves */
static void
i1pro_del(inst *pp) {
i1pro *p = (i1pro *)pp;
del_i1proimp(p);
if (p->icom != NULL)
p->icom->del(p->icom);
p->vdel(pp);
free(p);
}
/* Constructor */
extern i1pro *new_i1pro(icoms *icom, instType dtype) {
i1pro *p;
int rv;
if ((p = (i1pro *)calloc(sizeof(i1pro),1)) == NULL) {
a1loge(icom->log, 1, "new_i1pro: malloc failed!\n");
return NULL;
}
p->log = new_a1log_d(icom->log);
/* Inst methods */
p->init_coms = i1pro_init_coms;
p->init_inst = i1pro_init_inst;
p->capabilities = i1pro_capabilities;
p->get_serial_no = i1pro_get_serial_no;
p->check_mode = i1pro_check_mode;
p->set_mode = i1pro_set_mode;
p->get_set_opt = i1pro_get_set_opt;
p->read_strip = i1pro_read_strip;
p->read_sample = i1pro_read_sample;
p->read_refrate = i1pro_read_refrate;
p->get_n_a_cals = i1pro_get_n_a_cals;
p->calibrate = i1pro_calibrate;
p->meas_delay = i1pro_meas_delay;
p->white_change = i1pro_white_change;
p->interp_error = i1pro_interp_error;
p->del = i1pro_del;
p->icom = icom;
p->dtype = dtype;
i1pro_determine_capabilities(p);
if ((rv = add_i1proimp(p)) != I1PRO_OK) {
free(p);
a1loge(icom->log, 1, "new_i1pro: error %d creating i1proimp\n",rv);
return NULL;
}
return p;
}
|