Instrument Neutral Distributed Interface INDI  1.8.0
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
INDI::Weather Class Reference

#include <indiweather.h>

Inheritance diagram for INDI::Weather:
INDI::DefaultDevice INDI::WeatherInterface INDI::BaseDevice MBox OpenWeatherMap Vantage WeatherSafetyProxy WeatherSimulator WeatherWatcher WunderGround

Public Types

enum  WeatherLocation { LOCATION_LATITUDE, LOCATION_LONGITUDE, LOCATION_ELEVATION }
 
enum  { CONNECTION_NONE = 1 << 0, CONNECTION_SERIAL = 1 << 1, CONNECTION_TCP = 1 << 2 }
 
- Public Types inherited from INDI::BaseDevice
enum  INDI_ERROR { INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4 }
 
enum  DRIVER_INTERFACE {
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15)
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. A driver may implement one or more interfaces. More...
 

Public Member Functions

 Weather ()
 
virtual bool initProperties () override
 Initilize properties initial state and value. The child class must implement this function. More...
 
virtual bool updateProperties () override
 updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before. More...
 
virtual bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override
 Process the client newSwitch command. More...
 
virtual bool ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override
 Process the client newNumber command. More...
 
virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) override
 Process the client newSwitch command. More...
 
virtual bool ISSnoopDevice (XMLEle *root) override
 Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver. More...
 
- Public Member Functions inherited from INDI::DefaultDevice
 DefaultDevice ()
 
virtual ~DefaultDevice () override
 
void addAuxControls ()
 Add Debug, Simulation, and Configuration options to the driver. More...
 
void addDebugControl ()
 Add Debug control to the driver. More...
 
void addSimulationControl ()
 Add Simulation control to the driver. More...
 
void addConfigurationControl ()
 Add Configuration control to the driver. More...
 
void addPollPeriodControl ()
 Add Polling period control to the driver. More...
 
void resetProperties ()
 Set all properties to IDLE state. More...
 
void defineNumber (INumberVectorProperty *nvp)
 Define number vector to client & register it. Alternatively, IDDefNumber can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineText (ITextVectorProperty *tvp)
 Define text vector to client & register it. Alternatively, IDDefText can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineSwitch (ISwitchVectorProperty *svp)
 Define switch vector to client & register it. Alternatively, IDDefswitch can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineLight (ILightVectorProperty *lvp)
 Define light vector to client & register it. Alternatively, IDDeflight can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineBLOB (IBLOBVectorProperty *bvp)
 Define BLOB vector to client & register it. Alternatively, IDDefBLOB can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
virtual bool deleteProperty (const char *propertyName)
 Delete a property and unregister it. It will also be deleted from all clients. More...
 
virtual void setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
 Set connection switch status in the client. More...
 
int SetTimer (uint32_t ms)
 Set a timer to call the function TimerHit after ms milliseconds. More...
 
void RemoveTimer (int id)
 Remove timer added with SetTimer. More...
 
virtual const char * getDriverExec ()
 
virtual const char * getDriverName ()
 
void setVersion (uint16_t vMajor, uint16_t vMinor)
 Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...
 
uint16_t getMajorVersion ()
 
uint16_t getMinorVersion ()
 
virtual void ISGetProperties (const char *dev)
 define the driver's properties to the client. Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device. More...
 
virtual bool ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Process the client newBLOB command. More...
 
virtual uint16_t getDriverInterface () override
 
void setDriverInterface (uint16_t value)
 setInterface Set driver interface. By default the driver interface is set to GENERAL_DEVICE. You may send an ORed list of DeviceInterface values. More...
 
- Public Member Functions inherited from INDI::BaseDevice
 BaseDevice ()
 
virtual ~BaseDevice ()
 
INumberVectorPropertygetNumber (const char *name)
 
ITextVectorPropertygetText (const char *name)
 
ISwitchVectorPropertygetSwitch (const char *name)
 
ILightVectorPropertygetLight (const char *name)
 
IBLOBVectorPropertygetBLOB (const char *name)
 
IPState getPropertyState (const char *name)
 
IPerm getPropertyPermission (const char *name)
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
INDI::PropertygetProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
std::vector< INDI::Property * > * getProperties ()
 Return a list of all properties in the device. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
bool isConnected ()
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName ()
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
std::string messageQueue (int index) const
 
std::string lastMessage ()
 
void setMediator (INDI::BaseMediator *med)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator ()
 
const char * getDriverName ()
 
const char * getDriverExec ()
 
const char * getDriverVersion ()
 

Public Attributes

enum INDI::Weather:: { ... }  WeatherConnection
 

Protected Member Functions

virtual void TimerHit () override
 TimerHit Keep calling updateWeather() until it is successful, if it fails upon first connection. More...
 
virtual bool updateLocation (double latitude, double longitude, double elevation)
 Update weather station location. More...
 
void setWeatherConnection (const uint8_t &value)
 setWeatherConnection Set Weather connection mode. Child class should call this in the constructor before Weather registers any connection interfaces More...
 
uint8_t getWeatherConnection () const
 
virtual bool saveConfigItems (FILE *fp) override
 saveConfigItems Save specific properties in the provide config file handler. Child class usually override this function to save their own properties and the base class saveConfigItems(fp) must be explicitly called by each child class. The Default Device saveConfigItems(fp) only save Debug properties options in the config file. More...
 
virtual bool Handshake ()
 perform handshake with device to check communication More...
 
- Protected Member Functions inherited from INDI::DefaultDevice
void setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
 setDynamicPropertiesBehavior controls handling of dynamic properties. Dyanmic properties are those generated from an external skeleton XML file. By default all properties, including dynamic properties, are defined to the client in ISGetProperties(). Furthermore, when ┼▒deleteProperty(properyName) is called, the dynamic property is deleted by default, and can only be restored by calling buildSkeleton(filename) again. However, it is sometimes desirable to skip the definition of the dynamic properties on startup and delegate this task to the child class. To control this behavior, set enabled to false. More...
 
virtual bool loadConfig (bool silent=false, const char *property=nullptr)
 Load the last saved configuration file. More...
 
virtual bool saveConfig (bool silent=false, const char *property=nullptr)
 Save the current properties in a configuration file. More...
 
virtual bool purgeConfig ()
 purgeConfig Remove config file from disk. More...
 
virtual bool saveAllConfigItems (FILE *fp)
 saveAllConfigItems Save all the drivers' properties in the configuration file More...
 
virtual bool loadDefaultConfig ()
 Load the default configuration file. More...
 
void setDebug (bool enable)
 Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...
 
void setSimulation (bool enable)
 Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...
 
virtual void debugTriggered (bool enable)
 Inform driver that the debug option was triggered. This function is called after setDebug is triggered by the client. Reimplement this function if your driver needs to take specific action after debug is enabled/disabled. Otherwise, you can use isDebug() to check if simulation is enabled or disabled. More...
 
virtual void simulationTriggered (bool enable)
 Inform driver that the simulation option was triggered. This function is called after setSimulation is triggered by the client. Reimplement this function if your driver needs to take specific action after simulation is enabled/disabled. Otherwise, you can use isSimulation() to check if simulation is enabled or disabled. More...
 
bool isDebug ()
 
bool isSimulation ()
 
virtual bool Connect ()
 Connect to the device. INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation. More...
 
virtual bool Disconnect ()
 Disconnect from device. More...
 
void registerConnection (Connection::Interface *newConnection)
 registerConnection Add new connection plugin to the existing connection pool. The connection type shall be defined to the client in ISGetProperties() More...
 
bool unRegisterConnection (Connection::Interface *existingConnection)
 unRegisterConnection Remove connection from existing pool More...
 
Connection::InterfacegetActiveConnection ()
 
void setDefaultPollingPeriod (uint32_t period)
 
uint32_t getPollingPeriod ()
 
virtual const char * getDefaultName ()=0
 
- Protected Member Functions inherited from INDI::BaseDevice
int buildProp (XMLEle *root, char *errmsg)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (XMLEle *root, char *errmsg)
 handle SetXXX commands from client More...
 
int setBLOB (IBLOBVectorProperty *pp, XMLEle *root, char *errmsg)
 Parse and store BLOB in the respective vector. More...
 
- Protected Member Functions inherited from INDI::WeatherInterface
 WeatherInterface (DefaultDevice *defaultDevice)
 
virtual ~WeatherInterface ()
 
void initProperties (const char *statusGroup, const char *paramsGroup)
 Initilize focuser properties. It is recommended to call this function within initProperties() of your primary device. More...
 
bool updateProperties ()
 updateProperties Define or Delete Rotator properties based on the connection status of the base device More...
 
bool processNumber (const char *dev, const char *name, double values[], char *names[], int n)
 Process focus number properties. More...
 
virtual IPState updateWeather ()
 updateWeather Update weather conditions from device or service. The function should not change the state of any property in the device as this is handled by Weather. It should only update the raw values. More...
 
void addParameter (std::string name, std::string label, double numMinOk, double numMaxOk, double percWarning)
 addParameter Add a physical weather measurable parameter to the weather driver. The weather value has three zones: More...
 
bool setCriticalParameter (std::string param)
 setCriticalParameter Set parameter that is considered critical to the operation of the observatory. The parameter state can affect the overall weather driver state which signals the client to take appropriate action depending on the severity of the state. More...
 
void setParameterValue (std::string name, double value)
 setParameterValue Update weather parameter value More...
 
void syncCriticalParameters ()
 updateWeatherState Send update weather state to client More...
 

Protected Attributes

INumberVectorProperty LocationNP
 
INumber LocationN [3]
 
ITextVectorProperty ActiveDeviceTP
 
IText ActiveDeviceT [1] {}
 
INumber UpdatePeriodN [1]
 
INumberVectorProperty UpdatePeriodNP
 
ISwitch RefreshS [1]
 
ISwitchVectorProperty RefreshSP
 
ISwitch OverrideS [1]
 
ISwitchVectorProperty OverrideSP
 
Connection::SerialserialConnection {nullptr}
 
Connection::TCPtcpConnection {nullptr}
 
int PortFD = -1
 
int updateTimerID { -1 }
 
- Protected Attributes inherited from INDI::DefaultDevice
uint32_t POLLMS = 1000
 Period in milliseconds to call TimerHit(). Default 1000 ms. More...
 
- Protected Attributes inherited from INDI::WeatherInterface
INumberParametersN {nullptr}
 
INumberVectorProperty ParametersNP
 
INumberVectorPropertyParametersRangeNP {nullptr}
 
uint8_t nRanges {0}
 
ILightcritialParametersL {nullptr}
 
ILightVectorProperty critialParametersLP
 

Detailed Description

Definition at line 68 of file indiweather.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
CONNECTION_NONE 
CONNECTION_SERIAL 

Do not use any connection plugin

CONNECTION_TCP 

For regular serial and bluetooth connections

Definition at line 81 of file indiweather.h.

◆ WeatherLocation

Enumerator
LOCATION_LATITUDE 
LOCATION_LONGITUDE 
LOCATION_ELEVATION 

Definition at line 71 of file indiweather.h.

Constructor & Destructor Documentation

◆ Weather()

Weather::Weather ( )

Definition at line 37 of file indiweather.cpp.

Member Function Documentation

◆ getWeatherConnection()

uint8_t Weather::getWeatherConnection ( ) const
protected
Returns
Get current Weather connection mode

Definition at line 400 of file indiweather.cpp.

◆ Handshake()

bool Weather::Handshake ( )
protectedvirtual

perform handshake with device to check communication

Reimplemented in MBox, and Vantage.

Definition at line 382 of file indiweather.cpp.

◆ initProperties()

bool Weather::initProperties ( )
overridevirtual

Initilize properties initial state and value. The child class must implement this function.

Returns
True if initilization is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in WeatherSafetyProxy, OpenWeatherMap, WeatherWatcher, WunderGround, MBox, Vantage, and WeatherSimulator.

Definition at line 41 of file indiweather.cpp.

◆ ISNewNumber()

bool Weather::ISNewNumber ( const char *  dev,
const char *  name,
double  values[],
char *  names[],
int  n 
)
overridevirtual

Process the client newNumber command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in WeatherSafetyProxy, MBox, and WeatherSimulator.

Definition at line 175 of file indiweather.cpp.

◆ ISNewSwitch()

bool Weather::ISNewSwitch ( const char *  dev,
const char *  name,
ISState states,
char *  names[],
int  n 
)
overridevirtual

Process the client newSwitch command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in WeatherSafetyProxy, and MBox.

Definition at line 133 of file indiweather.cpp.

◆ ISNewText()

bool Weather::ISNewText ( const char *  dev,
const char *  name,
char *  texts[],
char *  names[],
int  n 
)
overridevirtual

Process the client newSwitch command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in WeatherSafetyProxy, OpenWeatherMap, WeatherWatcher, and WunderGround.

Definition at line 227 of file indiweather.cpp.

◆ ISSnoopDevice()

bool Weather::ISSnoopDevice ( XMLEle root)
overridevirtual

Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Definition at line 246 of file indiweather.cpp.

◆ saveConfigItems()

bool Weather::saveConfigItems ( FILE *  fp)
overrideprotectedvirtual

saveConfigItems Save specific properties in the provide config file handler. Child class usually override this function to save their own properties and the base class saveConfigItems(fp) must be explicitly called by each child class. The Default Device saveConfigItems(fp) only save Debug properties options in the config file.

Parameters
fpPointer to config file handler
Returns
True if successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in WeatherSafetyProxy, OpenWeatherMap, WeatherWatcher, WunderGround, and WeatherSimulator.

Definition at line 368 of file indiweather.cpp.

◆ setWeatherConnection()

void Weather::setWeatherConnection ( const uint8_t &  value)
protected

setWeatherConnection Set Weather connection mode. Child class should call this in the constructor before Weather registers any connection interfaces

Parameters
valueORed combination of WeatherConnection values.

Definition at line 405 of file indiweather.cpp.

◆ TimerHit()

void Weather::TimerHit ( )
overrideprotectedvirtual

TimerHit Keep calling updateWeather() until it is successful, if it fails upon first connection.

Reimplemented from INDI::DefaultDevice.

Definition at line 280 of file indiweather.cpp.

◆ updateLocation()

bool Weather::updateLocation ( double  latitude,
double  longitude,
double  elevation 
)
protectedvirtual

Update weather station location.

Parameters
latitudeSite latitude in degrees.
longitudeSite latitude in degrees increasing eastward from Greenwich (0 to 360).
elevationSite elevation in meters.
Returns
True if successful, false otherwise
Note
This function performs no action unless subclassed by the child class if required.

Reimplemented in OpenWeatherMap, and WunderGround.

Definition at line 328 of file indiweather.cpp.

◆ updateProperties()

bool Weather::updateProperties ( )
overridevirtual

updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before.

Returns
True if update is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in WeatherSafetyProxy, MBox, and WeatherSimulator.

Definition at line 101 of file indiweather.cpp.

Member Data Documentation

◆ ActiveDeviceT

IText INDI::Weather::ActiveDeviceT[1] {}
protected

Definition at line 137 of file indiweather.h.

◆ ActiveDeviceTP

ITextVectorProperty INDI::Weather::ActiveDeviceTP
protected

Definition at line 136 of file indiweather.h.

◆ LocationN

INumber INDI::Weather::LocationN[3]
protected

Definition at line 133 of file indiweather.h.

◆ LocationNP

INumberVectorProperty INDI::Weather::LocationNP
protected

Definition at line 132 of file indiweather.h.

◆ OverrideS

ISwitch INDI::Weather::OverrideS[1]
protected

Definition at line 148 of file indiweather.h.

◆ OverrideSP

ISwitchVectorProperty INDI::Weather::OverrideSP
protected

Definition at line 149 of file indiweather.h.

◆ PortFD

int INDI::Weather::PortFD = -1
protected

Definition at line 154 of file indiweather.h.

◆ RefreshS

ISwitch INDI::Weather::RefreshS[1]
protected

Definition at line 144 of file indiweather.h.

◆ RefreshSP

ISwitchVectorProperty INDI::Weather::RefreshSP
protected

Definition at line 145 of file indiweather.h.

◆ serialConnection

Connection::Serial* INDI::Weather::serialConnection {nullptr}
protected

Definition at line 151 of file indiweather.h.

◆ tcpConnection

Connection::TCP* INDI::Weather::tcpConnection {nullptr}
protected

Definition at line 152 of file indiweather.h.

◆ UpdatePeriodN

INumber INDI::Weather::UpdatePeriodN[1]
protected

Definition at line 140 of file indiweather.h.

◆ UpdatePeriodNP

INumberVectorProperty INDI::Weather::UpdatePeriodNP
protected

Definition at line 141 of file indiweather.h.

◆ updateTimerID

int INDI::Weather::updateTimerID { -1 }
protected

Definition at line 155 of file indiweather.h.

◆ WeatherConnection

enum { ... } INDI::Weather::WeatherConnection

The documentation for this class was generated from the following files: