Instrument Neutral Distributed Interface INDI
2.0.2
|
#include <nexdome_beaver.h>
Public Member Functions | |
Beaver () | |
virtual | ~Beaver () override=default |
const char * | getDefaultName () override |
Set default name. More... | |
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 | ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override |
Number field updated. More... | |
virtual bool | ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override |
Switch field updated. More... | |
![]() | |
Dome () | |
virtual | ~Dome () |
virtual void | ISGetProperties (const char *dev) override |
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 | 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... | |
void | setDomeConnection (const uint8_t &value) |
setDomeConnection Set Dome connection mode. Child class should call this in the constructor before Dome registers any connection interfaces More... | |
uint8_t | getDomeConnection () const |
uint32_t | GetDomeCapability () const |
GetDomeCapability returns the capability of the dome. More... | |
void | SetDomeCapability (uint32_t cap) |
SetDomeCapability set the dome capabilities. All capabilities must be initialized. More... | |
bool | CanAbort () |
bool | CanAbsMove () |
bool | CanRelMove () |
bool | CanPark () |
bool | CanSync () |
bool | HasShutter () |
bool | HasVariableSpeed () |
bool | HasBacklash () |
bool | isLocked () |
isLocked, is the dome currently locked? More... | |
DomeState | getDomeState () const |
void | setDomeState (const DomeState &value) |
ShutterState | getShutterState () const |
void | setShutterState (const ShutterState &value) |
IPState | getMountState () const |
![]() | |
DefaultDevice () | |
virtual | ~DefaultDevice () override=default |
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 | defineProperty (INumberVectorProperty *property) |
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 | defineProperty (ITextVectorProperty *property) |
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 | defineProperty (ISwitchVectorProperty *property) |
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 | defineProperty (ILightVectorProperty *property) |
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... | |
void | defineProperty (IBLOBVectorProperty *property) |
void | defineProperty (INDI::Property &property) |
virtual bool | deleteProperty (const char *propertyName) |
Delete a property and unregister it. It will also be deleted from all clients. More... | |
bool | deleteProperty (INDI::Property &property) |
deleteProperty 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 () const |
uint16_t | getMinorVersion () const |
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... | |
uint16_t | getDriverInterface () const |
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... | |
void | watchDevice (const char *deviceName, const std::function< void(INDI::BaseDevice)> &callback) |
Add a device to the watch list. More... | |
![]() | |
ParentDevice (Type type) | |
~ParentDevice () | |
ParentDevice (ParentDevice &&other)=default | |
ParentDevice & | operator= (ParentDevice &&other)=default |
![]() | |
BaseDevice () | |
virtual | ~BaseDevice () |
void | registerProperty (const INDI::Property &property) |
Register the property to be able to observe and update. More... | |
void | registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type) |
int | removeProperty (const char *name, char *errmsg) |
Remove a property. More... | |
void | watchProperty (const char *name, const std::function< void(INDI::Property)> &callback, WATCH watch=WATCH_NEW) |
Call the callback function if property is available. More... | |
Property | getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const |
Return a property and its type given its name. More... | |
Properties | getProperties () |
Return a list of all properties in the device. More... | |
const Properties | getProperties () const |
INDI::PropertyNumber | getNumber (const char *name) const |
INDI::PropertyText | getText (const char *name) const |
INDI::PropertySwitch | getSwitch (const char *name) const |
INDI::PropertyLight | getLight (const char *name) const |
INDI::PropertyBlob | getBLOB (const char *name) const |
IPState | getPropertyState (const char *name) const |
IPerm | getPropertyPermission (const char *name) const |
void * | getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const |
Return a property and its type given its name. More... | |
void | addMessage (const std::string &msg) |
Add message to the driver's message queue. More... | |
void | checkMessage (XMLEle *root) |
void | doMessage (XMLEle *msg) |
const std::string & | messageQueue (size_t index) const |
const std::string & | lastMessage () const |
bool | isValid () const |
bool | isConnected () const |
void | attach () |
indicates that the device is ready More... | |
void | detach () |
indicates that the device is being removed More... | |
void | setMediator (INDI::BaseMediator *mediator) |
Set the driver's mediator to receive notification of news devices and updated property values. More... | |
INDI::BaseMediator * | getMediator () const |
void | setDeviceName (const char *dev) |
Set the device name. More... | |
const char * | getDeviceName () const |
bool | isDeviceNameMatch (const char *otherName) const |
Check that the device name matches the argument. More... | |
bool | isDeviceNameMatch (const std::string &otherName) const |
Check that the device name matches the argument. More... | |
const char * | getDriverName () const |
const char * | getDriverExec () const |
const char * | getDriverVersion () const |
uint16_t | getDriverInterface () const |
getDriverInterface returns ORed values of DRIVER_INTERFACE. It presents the device classes supported by the driver. More... | |
bool | buildSkeleton (const char *filename) |
Build driver properties from a skeleton file. More... | |
int | buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false) |
Build a property given the supplied XML element (defXXX) More... | |
int | setValue (const INDI::LilXmlElement &root, char *errmsg) |
handle SetXXX commands from client More... | |
operator BaseDevice * () | |
BaseDevice * | operator-> () |
bool | operator!= (std::nullptr_t) const |
bool | operator== (std::nullptr_t) const |
operator bool () const | |
operator bool () | |
Protected Types | |
enum | { DOME_STATUS_ROTATOR_MOVING = 0x0001 , DOME_STATUS_SHUTTER_MOVING = 0x0002 , DOME_STATUS_ROTATOR_ERROR = 0x0004 , DOME_STATUS_SHUTTER_ERROR = 0x0008 , DOME_STATUS_SHUTTER_COMM = 0x0010 , DOME_STATUS_UNSAFE_CW = 0x0020 , DOME_STATUS_UNSAFE_RG = 0x0040 , DOME_STATUS_SHUTTER_OPENED = 0x0080 , DOME_STATUS_SHUTTER_CLOSED = 0x0100 , DOME_STATUS_SHUTTER_OPENING = 0x0200 , DOME_STATUS_SHUTTER_CLOSING = 0x0400 , DOME_STATUS_ROTATOR_HOME = 0x0800 , DOME_STATUS_ROTATOR_PARKED = 0x1000 } |
![]() | |
enum | { SHUTTER_CLOSE_ON_PARK , SHUTTER_OPEN_ON_UNPARK } |
enum | { DM_OTA_SIDE_EAST , DM_OTA_SIDE_WEST , DM_OTA_SIDE_MOUNT , DM_OTA_SIDE_HA , DM_OTA_SIDE_IGNORE } |
Protected Member Functions | |
bool | Handshake () override |
Handshake. More... | |
virtual void | TimerHit () override |
Timer hit - update appropriate fields. More... | |
virtual IPState | MoveAbs (double az) override |
Rotator absolute move. More... | |
virtual IPState | MoveRel (double azDiff) override |
Rotator relative move (calc's offset and calles abs move) More... | |
virtual IPState | Move (DomeDirection dir, DomeMotionCommand operation) override |
Rotator move (calc's offset and calles abs move) More... | |
virtual bool | SetCurrentPark () override |
Rotator set park position to current. More... | |
virtual bool | SetDefaultPark () override |
Rotator set park position to default (0 az) More... | |
virtual IPState | ControlShutter (ShutterOperation operation) override |
open or close the shutter (will not show if shutter is not present) More... | |
virtual bool | Abort () override |
abort everything More... | |
virtual bool | saveConfigItems (FILE *fp) override |
INDI save config. More... | |
virtual IPState | Park () override |
Rotator park. More... | |
virtual IPState | UnPark () override |
Rotator unpark. More... | |
![]() | |
virtual bool | SetSpeed (double rpm) |
SetSpeed Set Dome speed. This does not initiate motion, it sets the speed for the next motion command. If motion is in progress, then change speed accordingly. More... | |
virtual bool | Sync (double az) |
Sync sets the dome current azimuth as the supplied azimuth position. More... | |
virtual bool | SetBacklash (int32_t steps) |
SetBacklash Set the dome backlash compensation value. More... | |
virtual bool | SetBacklashEnabled (bool enabled) |
SetBacklashEnabled Enables or disables the dome backlash compensation. More... | |
const char * | GetShutterStatusString (ShutterState status) |
getShutterStatusString More... | |
void | SetParkDataType (DomeParkData type) |
setParkDataType Sets the type of parking data stored in the park data file and presented to the user. More... | |
bool | InitPark () |
InitPark Loads parking data (stored in ~/.indi/ParkData.xml) that contains parking status and parking position. InitPark() should be called after successful connection to the dome on startup. More... | |
bool | isParked () |
isParked is dome currently parked? More... | |
void | SetParked (bool isparked) |
SetParked Change the mount parking status. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process. More... | |
double | GetAxis1Park () |
double | GetAxis1ParkDefault () |
void | SetAxis1Park (double value) |
SetRAPark Set current AZ parking position. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process. More... | |
void | SetAxis1ParkDefault (double steps) |
SetAxis1Park Set default AZ parking position. More... | |
const char * | LoadParkData () |
bool | WriteParkData () |
bool | GetTargetAz (double &Az, double &Alt, double &minAz, double &maxAz) |
GetTargetAz. More... | |
bool | Intersection (point3D p1, point3D p2, double r, double &mu1, double &mu2) |
Intersection Calculate the intersection of a ray and a sphere. The line segment is defined from p1 to p2. The sphere is of radius r and centered at (0,0,0). From http://local.wasp.uwa.edu.au/~pbourke/geometry/sphereline/ There are potentially two points of intersection given by p := p1 + mu1 (p2 - p1) p := p1 + mu2 (p2 - p1) More... | |
bool | OpticalCenter (point3D MountCenter, double dOpticalAxis, double Lat, double Ah, point3D &OP) |
OpticalCenter This function calculates the distance from the optical axis to the Dome center. More... | |
bool | OpticalVector (double Az, double Alt, point3D &OV) |
OpticalVector This function calculates a second point for determining the optical axis. More... | |
bool | CheckHorizon (double HA, double dec, double lat) |
CheckHorizon Returns true if telescope points above horizon. More... | |
void | UpdateMountCoords () |
updateCoords updates the horizontal coordinates (Az & Alt) of the mount from the snooped RA, DEC and observer's location. More... | |
virtual void | UpdateAutoSync () |
UpdateAutoSync This function calculates the target dome azimuth from the mount's target coordinates given the dome parameters. If the difference between the dome's and mount's azimuth angles exceeds the AutoSync threshold, the dome will be commanded to sync to the mount azimuth position. More... | |
double | Csc (double x) |
double | Sec (double x) |
![]() | |
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... | |
bool | loadConfig (INDI::Property &property) |
Load property config from the configuration file. If the property configuration is successfully parsed, the corresponding ISNewXXX is called with the values parsed from the config file. More... | |
virtual bool | saveConfig (bool silent=false, const char *property=nullptr) |
Save the current properties in a configuration file. More... | |
bool | saveConfig (INDI::Property &property) |
Save a property in the 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 () const |
bool | isSimulation () const |
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::Interface * | getActiveConnection () |
void | setActiveConnection (Connection::Interface *existingConnection) |
setActiveConnection Switch the active connection to the passed connection plugin More... | |
void | setDefaultPollingPeriod (uint32_t msec) |
setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver. More... | |
void | setPollingPeriodRange (uint32_t minimum, uint32_t maximum) |
setPollingPeriodRange Set the range permitted by the polling range in milliseconds More... | |
uint32_t | getPollingPeriod () const |
getPollingPeriod Return the polling period. More... | |
void | setCurrentPollingPeriod (uint32_t msec) |
setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver. More... | |
uint32_t | getCurrentPollingPeriod () const |
getCurrentPollingPeriod Return the current polling period. More... | |
uint32_t & | refCurrentPollingPeriod () __attribute__((deprecated)) |
uint32_t | refCurrentPollingPeriod () const __attribute__((deprecated)) |
bool | isConfigLoading () const |
isConfigLoading Check if driver configuration is currently in the process of getting loaded. More... | |
bool | isInitializationComplete () const |
isInitializationComplete Check if driver initialization is complete. More... | |
void | syncDriverInfo () |
syncDriverInfo sends the current driver information to the client. More... | |
DefaultDevice (const std::shared_ptr< DefaultDevicePrivate > &dd) | |
![]() | |
ParentDevice (const std::shared_ptr< ParentDevicePrivate > &dd) | |
![]() | |
BaseDevice (BaseDevicePrivate &dd) | |
BaseDevice (const std::shared_ptr< BaseDevicePrivate > &dd) | |
Definition at line 30 of file nexdome_beaver.h.
|
protected |
Definition at line 67 of file nexdome_beaver.h.
Beaver::Beaver | ( | ) |
Definition at line 41 of file nexdome_beaver.cpp.
|
overridevirtualdefault |
|
overrideprotectedvirtual |
|
overrideprotectedvirtual |
open or close the shutter (will not show if shutter is not present)
Reimplemented from INDI::Dome.
Definition at line 680 of file nexdome_beaver.cpp.
|
overridevirtual |
Set default name.
Implements INDI::DefaultDevice.
Definition at line 216 of file nexdome_beaver.cpp.
|
overrideprotectedvirtual |
|
overridevirtual |
Initilize properties initial state and value. The child class must implement this function.
Main Tab
Reimplemented from INDI::Dome.
Definition at line 49 of file nexdome_beaver.cpp.
|
overridevirtual |
Number field updated.
Home Position
Park Position
Reimplemented from INDI::Dome.
Definition at line 371 of file nexdome_beaver.cpp.
|
overridevirtual |
Switch field updated.
Reimplemented from INDI::Dome.
Definition at line 281 of file nexdome_beaver.cpp.
|
overrideprotectedvirtual |
Rotator move (calc's offset and calles abs move)
Reimplemented from INDI::Dome.
Definition at line 658 of file nexdome_beaver.cpp.
|
overrideprotectedvirtual |
Rotator absolute move.
Reimplemented from INDI::Dome.
Definition at line 623 of file nexdome_beaver.cpp.
|
overrideprotectedvirtual |
Rotator relative move (calc's offset and calles abs move)
Reimplemented from INDI::Dome.
Definition at line 640 of file nexdome_beaver.cpp.
|
overrideprotectedvirtual |
|
overrideprotectedvirtual |
|
overrideprotectedvirtual |
Rotator set park position to current.
Reimplemented from INDI::Dome.
Definition at line 837 of file nexdome_beaver.cpp.
|
overrideprotectedvirtual |
Rotator set park position to default (0 az)
Reimplemented from INDI::Dome.
Definition at line 855 of file nexdome_beaver.cpp.
|
overrideprotectedvirtual |
Timer hit - update appropriate fields.
Reimplemented from INDI::DefaultDevice.
Definition at line 446 of file nexdome_beaver.cpp.
|
overrideprotectedvirtual |
|
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.
Reimplemented from INDI::Dome.
Definition at line 137 of file nexdome_beaver.cpp.