device.h

#ifndef _GXPL_SERVICE_HEADER_
#define _GXPL_SERVICE_HEADER_

#include <gxPL/defs.h>
__BEGIN_C_DECLS
/* ========================================================================== */

/* types ==================================================================== */

typedef void (* gxPLDeviceListener) (gxPLDevice *, gxPLMessage *, void *);

/* internal public functions ================================================ */
gxPLMessage * gxPLDeviceMessageNew (gxPLDevice * device, gxPLMessageType type);

int gxPLDeviceMessageSend (gxPLDevice * device, gxPLMessage * message);

gxPLSetting * gxPLDeviceSetting (gxPLDevice * device);

int gxPLDeviceListenerAdd (gxPLDevice * device,
                           gxPLDeviceListener listener,
                           gxPLMessageType type,
                           char * schema_class, char * schema_type,
                           void * udata);

int gxPLDeviceListenerRemove (gxPLDevice * device,
                              gxPLDeviceListener listener);

gxPLApplication * gxPLDeviceParent (gxPLDevice * device);

const gxPLId * gxPLDeviceId (const gxPLDevice * device);

const char * gxPLDeviceVendorId (const gxPLDevice * device);

const char * gxPLDeviceDeviceId (const gxPLDevice * device);

const char * gxPLDeviceInstanceId (const gxPLDevice * device);

int gxPLDeviceIsEnabled (const gxPLDevice * device);

int gxPLDeviceHeartbeatInterval (const gxPLDevice * device);

long gxPLDeviceHeartbeatLast (const gxPLDevice * device);

const char * gxPLDeviceVersion (const gxPLDevice * device);

int gxPLDeviceIsRespondToBroadcast (const gxPLDevice * device);

int gxPLDeviceIsReportOwnMessages (const gxPLDevice * device);

int gxPLDeviceIsHubConfirmed (const gxPLDevice * device);

int gxPLDeviceIsConfigurale (const gxPLDevice * device);

int gxPLDeviceIsConfigured (const gxPLDevice * device);

int gxPLDeviceIdSet (gxPLDevice * device,  const gxPLId * id);

int gxPLDeviceVendorIdSet (gxPLDevice * device, const char * vendor_id);

int gxPLDeviceDeviceIdSet (gxPLDevice * device, const char * device_id);

int gxPLDeviceInstanceIdSet (gxPLDevice * device, const char * instance_id);

int gxPLDeviceVersionSet (gxPLDevice * device, const char * version);

int gxPLDeviceEnable (gxPLDevice * device, bool enabled);

int gxPLDeviceHeartbeatIntervalSet (gxPLDevice * device, int interval);

int gxPLDeviceRespondToBroadcastSet (gxPLDevice * device, bool respond);

int gxPLDeviceReportOwnMessagesSet (gxPLDevice * device, bool isreportownmsg);

int gxPLDeviceGroupAdd (gxPLDevice * device, const char * group_name);

int gxPLDeviceGroupAddFromString (gxPLDevice * device, const char * str);

int gxPLDeviceGroupCount (const gxPLDevice * device);

const char * gxPLDeviceGroupGet (const gxPLDevice * device, int index);

int gxPLDeviceGroupClearAll (gxPLDevice * device);

int gxPLDeviceGroupHave (const gxPLDevice * device);

int gxPLDeviceFilterAdd (gxPLDevice * device, gxPLMessageType type,
                         const gxPLId * source, const gxPLSchema * schema);

int gxPLDeviceFilterAddFromStr (gxPLDevice * device, char * filter);

int gxPLDeviceFilterCount (const gxPLDevice * device);

const char * gxPLDeviceFilterGet (const gxPLDevice * device, int index);

int gxPLDeviceFilterHave (const gxPLDevice * device);

int gxPLDeviceFilterClearAll (gxPLDevice * device);

const char * gxPLDeviceFilterToString (const gxPLFilter * filter);

/* types ==================================================================== */

typedef void (* gxPLDeviceConfigListener) (gxPLDevice *, void *);

/* structures =============================================================== */
typedef struct  _gxPLDeviceConfigItem {

  char * name; 
  gxPLConfigurableType type; 
  uint8_t values_max; 
  xVector values; 
} gxPLDeviceConfigItem;

/* internal public functions ================================================ */


int gxPLDeviceConfigListenerAdd (gxPLDevice * device,
                                 gxPLDeviceConfigListener listener,
                                 void * udata) ;

int gxPLDeviceConfigListenerRemove (gxPLDevice * device,
                                    gxPLDeviceConfigListener listener);

int gxPLDeviceConfigItemAdd (gxPLDevice * device, const char * name,
                             gxPLConfigurableType type, int max_values);

int gxPLDeviceConfigItemRemove (gxPLDevice * device, const char * name);

int gxPLDeviceConfigItemRemoveAll (gxPLDevice * device);

int gxPLDeviceConfigItemClearAll (gxPLDevice * device);

gxPLDeviceConfigItem * gxPLDeviceConfigItemFind (const gxPLDevice * device,
    const char * name);

int gxPLDeviceConfigValueCount (const gxPLDevice * device, const char * name);

int gxPLDeviceConfigValueAdd (gxPLDevice * device,
                              const char * name, const char * value);


int gxPLDeviceConfigValueSet (gxPLDevice * device,
                              const char * name, const char * value);

int gxPLDeviceConfigValueSetAt (gxPLDevice * device, const char * name,
                                int index, const char * value);

int gxPLDeviceConfigValueClearAll (gxPLDevice * device, const char * name);

const char * gxPLDeviceConfigValueGet (gxPLDevice * device, const char * name);

const char * gxPLDeviceConfigValueGetAt (gxPLDevice * device, const char * name, int index);

const char * gxPLDeviceConfigFilenameGet (const gxPLDevice * device);

int gxPLDeviceConfigSave (const gxPLDevice * device);

# ifdef __DOXYGEN__
// -----------------------------------------------------------------------------

#else
// -----------------------------------------------------------------------------
/*
 * @brief Return the installed config file, if any
 * the file name can not be changed if the device is not configured yet.
 * @param device pointer on the configurable device
 * @return 0, -1 if an error occurs
 */
int gxPLDeviceConfigFilenameSet (gxPLDevice * device, const char * filename);


// -----------------------------------------------------------------------------
# endif /* __DOXYGEN__ not defined */

/* ========================================================================== */
__END_C_DECLS
#endif /* _GXPL_SERVICE_HEADER_ defined */