Permalink
Branch: master
Find file Copy path
8aa4344 Feb 18, 2019
2 contributors

Users who have contributed to this file

@polakovic @rumengb
291 lines (247 sloc) 23.1 KB

INDIGO properties

Introduction

INDIGO properties and items are abstraction of INDI properties and items. As far as INDIGO uses software bus instead of XML messages, properties are first of all defined memory structures which are, if needed, mapped to XML or JSON textual representation.

Common properties

PropertyItemsComments
NameTypeRORequiredNameRequired
CONNECTIONswitchnoyesCONNECTEDyesItem values are undefined if state is not Idle or Ok.
DISCONNECTEDyes
INFOtextyesyesDEVICE_NAMEyes"Device in INDIGO strictly represents device itself and not device driver. Valid DEVICE_INTERFACE values are defined in indigo_driver.h as indigo_device_interface enumeration."
DEVICE_VERSIONyes
DEVICE_INTERFACEyes
FRAMEWORK_NAMEno
FRAMEWORK_VERSIONno
DEVICE_MODELno
DEVICE_FIRMWARE_REVISIONno
DEVICE_HARDWARE_REVISIONno
DEVICE_SERIAL_NUMBERno
SIMULATIONswitchnonoENABLEDyes
DISABLEDyes
CONFIGswitchnoyesLOADyes
SAVEyes
REMOVEyes
PROFILEswitchnoyesPROFILE_0,...yesSelect the profile number for subsequent CONFIG operation
DEVICE_PORTtextnonoPORTnoEither device path like "/dev/tty0" or URL like "lx200://host:port".
DEVICE_PORTSswitchnonovalid serial port nameWhen selected, it is copied to DEVICE_PORT property.

Properties are implemented by driver base class in indigo_driver.c.

CCD specific properties

PropertyItemsComments
NameTypeRORequiredNameRequired
CCD_INFOnumberyesyesWIDTHyes
HEIGHTyes
MAX_HORIZONTAL_BINyes
MAX_VERTICAL_BINyes
PIXEL_SIZEyes
PIXEL_WIDTHyes
PIXEL_HEIGHTyes
BITS_PER_PIXELyes
CCD_UPLOAD_MODEswitchnoyesCLIENTyes
LOCALyes
BOTHyes
PREVIEWyesSend JPEG preview to client
PREVIEW_LOCALyesSend JPEG preview to client and save original format locally
CCD_LOCAL_MODEtextnoyesDIRyesXXX is replaced by sequence.
PREFIXyes
CCD_EXPOSUREnumbernoyesEXPOSUREyes
CCD_STREAMINGnumbernonoEXPOSUREyesThe same as CCD_EXPOSURE, but will upload COUNT images. Use COUNT -1 for endless loop.
COUNTyes
CCD_ABORT_EXPOSUREswitchnoyesABORT_EXPOSUREyes
CCD_FRAMEnumbernonoLEFTyesIf BITS_PER_PIXEL can't be changed, set min and max to the same value.
TOPyes
WIDTHyes
HEIGHTyes
BITS_PER_PIXELyes
CCD_BINnumbernonoHORIZONTALyesCCD_MODE is prefered way how to set binning.
VERTICALyes
CCD_MODEswitchnoyesmode identifieryesCCD_MODE is a prefered way how to set binning, resolution, color mode etc.
CCD_READ_MODEswitchnonoHIGH_SPEEDyes
LOW_NOISEyes
CCD_GAINnumbernonoGAINyes
CCD_OFFSETnumbernonoOFFSETyes
CCD_GAMMAnumbernonoGAMMAyes
CCD_FRAME_TYPEswitchnoyesLIGHTyes
BIASyes
DARKyes
FLATyes
CCD_IMAGE_FORMATswitchnoyesRAWyes
FITSyes
XISFyes
JPEGyes
CCD_IMAGE_FILEtextnoyesFILEyes
CCD_IMAGEblobnoyesIMAGEyes
CCD_TEMPERATUREnumbernoTEMPERATUREyesIt depends on hardware if it is undefined, read-only or read-write.
CCD_COOLERswitchnonoONyes
OFFyes
CCD_COOLER_POWERnumberyesnoPOWERyesIt depends on hardware if it is undefined, read-only or read-write.
CCD_FITS_HEADERStextnoyesHEADER_1, ...yesString in form "name = value", "name = 'value'" or "comment text"

Properties are implemented by CCD driver base class in indigo_ccd_driver.c.

Wheel specific properties

PropertyItemsComments
NameTypeRORequiredNameRequired
WHEEL_SLOTnumbernoyesSLOTyes
WHEEL_SLOT_NAMEswitchnoyesSLOT_NAME_1, ...yes
WHEEL_SLOT_OFFSETswitchnoyesSLOT_OFFSET_1, ...yesValue is number of focuser steps

Properties are implemented by wheel driver base class in indigo_wheel_driver.c.

Focuser specific properties

PropertyItemsComments
NameTypeRORequiredNameRequired
FOCUSER_SPEEDnumbernonoSPEEDyes
FOCUSER_REVERSE_MOTIONswitchnonoENABLEDyes
DIABLEDyes
FOCUSER_DIRECTIONswitchnoyesMOVE_INWARDyes
MOVE_OUTWARDyes
FOCUSER_STEPSnumbernoyesSTEPSyes
FOCUSER_ON_POSITION_SETswitchnonoGOTOyes
SYNCyes
FOCUSER_POSITIONnumbernoPOSITIONyesIt depends on hardware if it is undefined, read-only or read-write.
FOCUSER_ABORT_MOTIONswitchnoyesABORT_MOTIONyes
FOCUSER_TEMPERATUREnumbernonoTEMPERATUREyes
FOCUSER_BACKLASHnumbernonoBACKLASHyesMechanical backlash compensation
FOCUSER_COMPENSATIONnumbernonoCOMPENSATIONyesTemperature compensation (if FOCUSER_MODE.AUTOMATIC is set
FOCUSER_MODEswitchnonoMANUALyesManual mode
AUTOMATICyesTemperature compensated mode
FOCUSER_LIMITSnumbernonoMIN_POSITIONyes
MAX_POSITIONyes

Properties are implemented by focuser driver base class in indigo_focuser_driver.c.

Mount specific properties

PropertyItemsComments
NameTypeRORequiredNameRequired
MOUNT_INFOtextnonoMODELyes
VENDORyes
FIRMWARE_VERSIONyes
MOUNT_GEOGRAPHIC_COORDINATESnumbernoyesLATITUDEyes
LONGITUDEyes
ELEVATIONyes
MOUNT_LST_TIMEnumbernoTIMEyesIt depends on hardware if it is undefined, read-only or read-write.
MOUNT_UTC_TIMEnumbernoTIMEyesIt depends on hardware if it is undefined, read-only or read-write.
OFFSETyes
MOUNT_SET_HOST_TIMEswitchnonoSETyes
MOUNT_PARKswitchnonoPARKEDyes
UNPARKEDyes
MOUT_PARK_SETswitchnonoDEFAULTyes
CURRENTyes
MOUNT_PARK_POSITIONnumbernonoRAyes
DECyes
MOUNT_ON_COORDINATES_SETswitchnoyesTRACKyes
SYNCyes
SLEWno
MOUNT_SLEW_RATEswitchnonoGUIDEno
CENTERINGno
FINDno
MAXno
MOUNT_MOTION_DECswitchnoyesNORTHyes
SOUTHyes
MOUNT_MOTION_RAswitchnoyesWESTyes
EASTyes
MOUNT_TRACK_RATEswitchnonoSIDEREALno
SOLARno
LUNARno
MOUNT_TRACKINGswitchnonoONyes
OFFyes
MOUNT_GUIDE_RATEnubernonoRAyes
DECyes
MOUNT_EQUATORIAL_COORDINATESnumbernoyesRAyes
DECyes
MOUNT_HORIZONTAL_COORDINATESnumbernonoALTyes
AZyes
MOUNT_ABORT_MOTIONswitchnoyesABORT_MOTIONyes
MOUNT_RAW_COORDINATESnumberyesyesRAyes
DECyes
MOUNT_ALIGNMENT_MODEswitchnoyesCONTROLLERyes
SINGLE_POINTyes
NEAREST_POINTyes
MULTI_POINTyes
MOUNT_ALIGNMENT_SELECT_POINTSswitchnoyespoint idyes
MOUNT_ALIGNMENT_DELETE_POINTS_PROPERTYswitchnoyespoint idyes
MOUNT_EPOCHnumbernoyesEPOCHyes
MOUNT_SIDE_OF_PIERswitchnoyesEASTyes
WESTyes

Properties are implemented by mount driver base class in indigo_mount_driver.c.

Guider specific properties

PropertyItemsComments
NameTypeRORequiredNameRequired
GUIDER_GUIDE_DECnumbernoyesNORTHyes
SOUTHyes
GUIDER_GUIDE_RAnumbernoyesEASTyes
WESTyes
GUIDER_RATEnumbernonoRATEyes% of sidereal rate
GUIDER_DEC_RATEnumbernonoDEC_RATEno% of sidereal rate

Properties are implemented by guider driver base class in indigo_guider_driver.c.

AO specific properties

PropertyItemsComments
NameTypeRORequiredNameRequired
AO_GUIDE_DECnumbernoyesNORTHyes
SOUTHyes
AO_GUIDE_RAnumbernoyesEASTyes
WESTyes
AO_RESETswitchnoyesCENTERyes
UNJAMno

Properties are implemented by AO driver base class in indigo_ao_driver.c.

Auxiliary properties

To be used by auxiliary devices like powerboxes, weather stations, etc.

PropertyItemsComments
NameTypeRORequiredNameRequired
AUX_POWER_OUTLETswitchnonoOUTLET_1yesEnable power outlets
OUTLET_2no
OUTLET_3no
OUTLET_4no
AUX_POWER_OUTLET_STATElightyesnoOUTLET_1yesPower outlets state (IDLE = unused, OK = used, ALERT = over-current etc.)
OUTLET_2no
OUTLET_3no
OUTLET_4no
AUX_POWER_OUTLET_CURRENTnumberyesnoOUTLET_1yesPower outlets current
noOUTLET_2no
noOUTLET_3no
noOUTLET_4no
AUX_HEATER_OUTLETnumbernonoOUTLET_1yesSet heater outlets power
OUTLET_2no
OUTLET_3no
OUTLET_4no
AUX_HEATER_OUTLET_STATElightyesnoOUTLET_1yesHeater outlets state (IDLE = unused, OK = used, ALERT = over-current etc.)
OUTLET_2no
OUTLET_3no
OUTLET_4no
AUX_HEATER_OUTLET_CURRENTnumberyesnoOUTLET_1yesHeater outlets current
OUTLET_2no
OUTLET_3no
OUTLET_4no
AUX_USB_PORTswitchnonoPORT_1yesEnable USB ports on smart hub
PORT_2no
PORT_3no
PORT_4no
PORT_5no
PORT_6no
PORT_7no
PORT_8no
AUX_USB_PORT_STATElightyesnoPORT_1yesUSB port state (IDLE = unused or disabled, OK = used, BUSY = transient state, ALERT = over-current etc.)
PORT_2no
PORT_3no
PORT_4no
PORT_5no
PORT_6no
PORT_7no
PORT_8no
AUX_DEW_CONTROLswitchnonoMANUALyesUse AUX_HEATER_OUTLET values
AUTOMATICyesSet power automatically
AUX_WEATHERnumberyesnoTEMPERATUREno
HUMIDITYno
DEVPOINTno
AUX_INFOnumberyesno...noAny number of any number items
AUX_CONTROLswitchnono...noAny number of any switch items