indiapi.h

Go to the documentation of this file.

#if 0
INDI
Copyright (C) 2003 Elwood C. Downey
2022 Ludovic Pollet
 
This library is free software;
you can redistribute it and / or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation;
either
version 2.1 of the License, or (at your option) any later version.
 
This library 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
Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public
License along with this library;
if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110 - 1301  USA
 
#endif
 
#pragma once
 
#include <stdio.h>
 
/*******************************************************************************
 * INDI wire protocol version implemented by this API.
 * N.B. this is independent of the API itself.
 */
 
#define INDIV 1.7
 
/* INDI Library version */
#include "indiversion.h"
 
/*******************************************************************************
 * Manifest constants
 */
 
typedef enum
{
ISS_OFF = 0, 
ISS_ON       
} ISState;
 
typedef enum
{
IPS_IDLE = 0, 
IPS_OK,       
IPS_BUSY,     
IPS_ALERT     
} IPState;
 
typedef enum
{
ISR_1OFMANY, 
ISR_ATMOST1, 
ISR_NOFMANY  
} ISRule;
 
typedef enum
{
IP_RO, 
IP_WO, 
IP_RW  
} IPerm;
 
// The XML strings for these attributes may be any length but implementations
// are only obligued to support these lengths for the various string attributes.
#define MAXINDINAME    64
#define MAXINDILABEL   64
#define MAXINDIDEVICE  64
#define MAXINDIGROUP   64
#define MAXINDIFORMAT  64
#define MAXINDIBLOBFMT 64
#define MAXINDITSTAMP  64
#define MAXINDIMESSAGE 255
 
/*******************************************************************************
 * Typedefs for each INDI Property type.
 *
 * INumber.format may be any printf-style appropriate for double
 * or style "m" to create sexigesimal using the form "%<w>.<f>m" where
 *   <w> is the total field width.
 *   <f> is the width of the fraction. valid values are:
 *      9  ->  :mm:ss.ss
 *      8  ->  :mm:ss.s
 *      6  ->  :mm:ss
 *      5  ->  :mm.m
 *      3  ->  :mm
 *
 * examples:
 *
 *   to produce     use
 *
 *    "-123:45"    %7.3m
 *  "  0:01:02"    %9.6m
 */
 
typedef struct _IText
{
char name[MAXINDINAME];
    char label[MAXINDILABEL];
    char *text;
    struct _ITextVectorProperty *tvp;
    void *aux0;
    void *aux1;
} IText;
 
typedef struct _ITextVectorProperty
{
    char device[MAXINDIDEVICE];
    char name[MAXINDINAME];
    char label[MAXINDILABEL];
    char group[MAXINDIGROUP];
    IPerm p;
    double timeout;
    IPState s;
    IText *tp;
    int ntp;
    char timestamp[MAXINDITSTAMP];
    void *aux;
} ITextVectorProperty;
 
typedef struct _INumber
{
    char name[MAXINDINAME];
    char label[MAXINDILABEL];
    char format[MAXINDIFORMAT];
    double min;
    double max;
    double step;
    double value;
    struct _INumberVectorProperty *nvp;
    void *aux0;
    void *aux1;
} INumber;
 
typedef struct _INumberVectorProperty
{
    char device[MAXINDIDEVICE];
    char name[MAXINDINAME];
    char label[MAXINDILABEL];
    char group[MAXINDIGROUP];
    IPerm p;
    double timeout;
    IPState s;
    INumber *np;
    int nnp;
    char timestamp[MAXINDITSTAMP];
    void *aux;
} INumberVectorProperty;
 
typedef struct _ISwitch
{
    char name[MAXINDINAME];
    char label[MAXINDILABEL];
    ISState s;
    struct _ISwitchVectorProperty *svp;
    void *aux;
} ISwitch;
 
typedef struct _ISwitchVectorProperty
{
    char device[MAXINDIDEVICE];
    char name[MAXINDINAME];
    char label[MAXINDILABEL];
    char group[MAXINDIGROUP];
    IPerm p;
    ISRule r;
    double timeout;
    IPState s;
    ISwitch *sp;
    int nsp;
    char timestamp[MAXINDITSTAMP];
    void *aux;
} ISwitchVectorProperty;
 
typedef struct _ILight
{
    char name[MAXINDINAME];
    char label[MAXINDILABEL];
    IPState s;
    struct _ILightVectorProperty *lvp;
    void *aux;
} ILight;
 
typedef struct _ILightVectorProperty
{
    char device[MAXINDIDEVICE];
    char name[MAXINDINAME];
    char label[MAXINDILABEL];
    char group[MAXINDIGROUP];
    IPState s;
    ILight *lp;
    int nlp;
    char timestamp[MAXINDITSTAMP];
    void *aux;
} ILightVectorProperty;
 
typedef struct _IBLOB/* one BLOB descriptor */
{
    char name[MAXINDINAME];
    char label[MAXINDILABEL];
    char format[MAXINDIBLOBFMT];
    void *blob;
    int bloblen;
    int size;
    struct _IBLOBVectorProperty *bvp;
    void *aux0;
    void *aux1;
    void *aux2;
} IBLOB;
 
typedef struct _IBLOBVectorProperty /* BLOB vector property descriptor */
{
    char device[MAXINDIDEVICE];
    char name[MAXINDINAME];
    char label[MAXINDILABEL];
    char group[MAXINDIGROUP];
    IPerm p;
    double timeout;
    IPState s;
    IBLOB *bp;
    int nbp;
    char timestamp[MAXINDITSTAMP];
    void *aux;
} IBLOBVectorProperty;
 
#define NARRAY(a) (sizeof(a) / sizeof(a[0]))
 
#define assert_mem(p) if((p) == 0) { fprintf(stderr, "%s(%s): Failed to allocate memory\n", __FILE__, __func__); exit(1); }
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
// FIXME: duplicated from indidevapi.h. Can we share ?
#ifdef __cplusplus
}
#endif