|
| | IMU () |
| |
| virtual | ~IMU () |
| |
| void | setSupportedConnections (const uint8_t &value) |
| |
| uint8_t | getSupportedConnections () const |
| | Get the currently configured supported connection modes.
|
| |
| virtual const char * | getDefaultName () override |
| |
| virtual bool | initProperties () override |
| | Initialize properties initial state and value. The child class must implement this function.
|
| |
| 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.
|
| |
| virtual bool | Handshake () |
| | Performs a device-specific handshake after a connection is established. This method should be overridden by concrete IMU drivers to implement any necessary communication checks or initialization sequences with the hardware. The base implementation does nothing and returns false.
|
| |
| | DefaultDevice () |
| |
| virtual | ~DefaultDevice () override=default |
| |
| void | addAuxControls () |
| | Add Debug, Simulation, and Configuration options to the driver.
|
| |
| void | addDebugControl () |
| | Add Debug control to the driver.
|
| |
| void | addSimulationControl () |
| | Add Simulation control to the driver.
|
| |
| void | addConfigurationControl () |
| | Add Configuration control to the driver.
|
| |
| void | addPollPeriodControl () |
| | Add Polling period control to the driver.
|
| |
| void | addNicknameControl () |
| | Add Nickname text property to the driver.
|
| |
| void | resetProperties () |
| | Set all properties to IDLE state.
|
| |
| 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.
|
| |
| 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.
|
| |
| 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.
|
| |
| 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.
|
| |
| 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.
|
| |
| 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.
|
| |
| bool | deleteProperty (INDI::Property &property) |
| | deleteProperty Delete a property and unregister it. It will also be deleted from all clients.
|
| |
| virtual void | setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr) |
| | Set connection switch status in the client.
|
| |
| int | SetTimer (uint32_t ms) |
| | Set a timer to call the function TimerHit after ms milliseconds.
|
| |
| void | RemoveTimer (int id) |
| | Remove timer added with SetTimer.
|
| |
| virtual void | TimerHit () |
| | Callback function to be called once SetTimer duration elapses.
|
| |
| 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.
|
| |
| uint16_t | getMajorVersion () const |
| |
| uint16_t | getMinorVersion () const |
| |
| 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.
|
| |
| 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.
|
| |
| virtual bool | ISSnoopDevice (XMLEle *root) |
| | Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver.
|
| |
| bool | ISNewProperty (INDI::Property &property, const std::string &elementName, const std::any &value) |
| | Generic convenience function to update a property element as if by client request, simulating an ISNew... call.
|
| |
| template<typename PropertyType , typename ValueType > |
| bool | updateProperty (PropertyType &property, ValueType *values, char *names[], int n, std::function< bool()> updater, bool saveConfig=false) |
| | Generic helper function to update an INDI property based on an external operation.
|
| |
| uint32_t | getDriverInterface () const |
| |
| void | setDriverInterface (uint32_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.
|
| |
| void | watchDevice (const char *deviceName, const std::function< void(INDI::BaseDevice)> &callback) |
| | Add a device to the watch list.
|
| |
| | 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.
|
| |
| void | registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type) |
| |
| int | removeProperty (const char *name, char *errmsg) |
| | Remove a property.
|
| |
| void | watchProperty (const char *name, const std::function< void(INDI::Property)> &callback, WATCH watch=WATCH_NEW) |
| | Call the callback function if property is available.
|
| |
| Property | getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const |
| | Return a property and its type given its name.
|
| |
| Properties | getProperties () |
| | Return a list of all properties in the device.
|
| |
| 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.
|
| |
| void | addMessage (const std::string &msg) |
| | Add message to the driver's message queue.
|
| |
| 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 | isSameDevice (const BaseDevice &other) const |
| |
| bool | isConnected () const |
| |
| void | attach () |
| | indicates that the device is ready
|
| |
| void | detach () |
| | indicates that the device is being removed
|
| |
| void | setMediator (INDI::BaseMediator *mediator) |
| | Set the driver's mediator to receive notification of news devices and updated property values.
|
| |
| INDI::BaseMediator * | getMediator () const |
| |
| void | setDeviceName (const char *dev) |
| | Set the device name.
|
| |
| const char * | getDeviceName () const |
| |
| bool | isDeviceNameMatch (const char *otherName) const |
| | Check that the device name matches the argument.
|
| |
| bool | isDeviceNameMatch (const std::string &otherName) const |
| | Check that the device name matches the argument.
|
| |
| 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.
|
| |
| bool | buildSkeleton (const char *filename) |
| | Build driver properties from a skeleton file.
|
| |
| int | buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false) |
| | Build a property given the supplied XML element (defXXX)
|
| |
| int | setValue (const INDI::LilXmlElement &root, char *errmsg) |
| | handle SetXXX commands from client
|
| |
| | operator BaseDevice * () |
| |
| BaseDevice * | operator-> () |
| |
| bool | operator!= (std::nullptr_t) const |
| |
| bool | operator== (std::nullptr_t) const |
| |
| | operator bool () const |
| |
| | operator bool () |
| |
| uint32_t | GetCapability () const |
| | GetIMUCapability returns the capability of the IMU device.
|
| |
| void | SetCapability (uint32_t cap) |
| | SetIMUCapability sets the IMU capabilities. All capabilities must be initialized.
|
| |
| bool | HasOrientation () |
| |
| bool | HasAcceleration () |
| |
| bool | HasGyroscope () |
| |
| bool | HasMagnetometer () |
| |
| bool | HasCalibration () |
| |
| bool | HasTemperature () |
| |
| bool | HasStabilityMonitoring () |
| |
|
| void | QuaternionToEuler (double i, double j, double k, double w, double &roll, double &pitch, double &yaw) |
| |
| void | EulerToQuaternion (double roll, double pitch, double yaw, double &i, double &j, double &k, double &w) |
| |
| virtual bool | ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override |
| | Process the client newNumber command.
|
| |
| virtual bool | ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override |
| | Process the client newSwitch command.
|
| |
| virtual bool | ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) override |
| | Process the client newSwitch command.
|
| |
| 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.
|
| |
| bool | SetOrientationData (double roll, double pitch, double yaw, double w=0.0) override |
| | SetOrientationData Set the orientation data (Roll, Pitch, Yaw, Quaternion W)
|
| |
| bool | SetAccelerationData (double x, double y, double z) override |
| | SetAccelerationData Set the linear acceleration data.
|
| |
| bool | SetGyroscopeData (double x, double y, double z) override |
| | SetGyroscopeData Set the angular velocity data.
|
| |
| bool | SetMagnetometerData (double x, double y, double z) override |
| | SetMagnetometerData Set the magnetic field strength data.
|
| |
| virtual bool | StartCalibration () override |
| | StartCalibration Initiate the calibration sequence.
|
| |
| virtual bool | SaveCalibrationData () override |
| | SaveCalibrationData Save the current calibration data.
|
| |
| virtual bool | LoadCalibrationData () override |
| | LoadCalibrationData Load previously saved calibration data.
|
| |
| virtual bool | ResetCalibration () override |
| | ResetCalibration Reset calibration data.
|
| |
| virtual bool | SetPowerMode (const std::string &mode) override |
| | SetPowerMode Set the power mode of the IMU sensor.
|
| |
| virtual bool | SetOperationMode (const std::string &mode) override |
| | SetOperationMode Set the operation mode of the IMU sensor.
|
| |
| virtual bool | SetDistanceUnits (bool metric) override |
| | SetUnits Set the units for sensor data.
|
| |
| virtual bool | SetAngularUnits (bool degrees) override |
| | SetAngularUnits Set the angular units for sensor data.
|
| |
| virtual bool | SetUpdateRate (double rate) override |
| | SetUpdateRate Set the sensor polling frequency.
|
| |
| void | RecalculateAstroCoordinates () |
| |
| void | setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled) |
| | setDynamicPropertiesBehavior controls handling of dynamic properties. Dynamic 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.
|
| |
| virtual bool | loadConfig (bool silent=false, const char *property=nullptr) |
| | Load the last saved configuration file.
|
| |
| 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.
|
| |
| virtual bool | saveConfig (bool silent=false, const char *property=nullptr) |
| | Save the current properties in a configuration file.
|
| |
| bool | saveConfig (INDI::Property &property) |
| | Save a property in the configuration file.
|
| |
| virtual bool | purgeConfig () |
| | purgeConfig Remove config file from disk.
|
| |
| virtual bool | saveAllConfigItems (FILE *fp) |
| | saveAllConfigItems Save all the drivers' properties in the configuration file
|
| |
| virtual bool | loadDefaultConfig () |
| | Load the default configuration file.
|
| |
| void | setDebug (bool enable) |
| | Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client.
|
| |
| void | setSimulation (bool enable) |
| | Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client.
|
| |
| 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.
|
| |
| 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.
|
| |
| 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.
|
| |
| virtual bool | Disconnect () |
| | Disconnect from device.
|
| |
| 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()
|
| |
| bool | unRegisterConnection (Connection::Interface *existingConnection) |
| | unRegisterConnection Remove connection from existing pool
|
| |
| Connection::Interface * | getActiveConnection () |
| |
| void | setActiveConnection (Connection::Interface *existingConnection) |
| | setActiveConnection Switch the active connection to the passed connection plugin
|
| |
| void | setDefaultPollingPeriod (uint32_t msec) |
| | setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver.
|
| |
| void | setPollingPeriodRange (uint32_t minimum, uint32_t maximum) |
| | setPollingPeriodRange Set the range permitted by the polling range in milliseconds
|
| |
| uint32_t | getPollingPeriod () const |
| | getPollingPeriod Return the polling period.
|
| |
| void | setCurrentPollingPeriod (uint32_t msec) |
| | setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver.
|
| |
| uint32_t | getCurrentPollingPeriod () const |
| | getCurrentPollingPeriod Return the current polling period.
|
| |
| 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.
|
| |
| bool | isInitializationComplete () const |
| | isInitializationComplete Check if driver initialization is complete.
|
| |
| void | syncDriverInfo () |
| | syncDriverInfo sends the current driver information to the client.
|
| |
| void | setDeviceNickname (const char *nick) |
| | Set the device nickname.
|
| |
| const char * | getDeviceNickname () |
| |
| const char * | lookupDeviceNicknameFromId (const char *identifier, const char *device=nullptr) |
| | Lookup device nickname for an identifier.
|
| |
| bool | setDeviceNicknameFromId (const char *identifier) |
| | Set device nickname based on an identifier.
|
| |
| void | saveNicknameId (const char *nickname, const char *identifier) |
| |
| virtual void | nicknameSet (const char *nickname) |
| | Inform driver that the nickname has been set.
|
| |
| | DefaultDevice (const std::shared_ptr< DefaultDevicePrivate > &dd) |
| |
| | ParentDevice (const std::shared_ptr< ParentDevicePrivate > &dd) |
| |
| | BaseDevice (BaseDevicePrivate &dd) |
| |
| | BaseDevice (const std::shared_ptr< BaseDevicePrivate > &dd) |
| |
| | IMUInterface (DefaultDevice *defaultDevice) |
| |
| virtual | ~IMUInterface ()=default |
| |
| void | initProperties (const std::string &groupName) |
| | Initialize IMU properties. It is recommended to call this function within initProperties() of your primary device.
|
| |
| bool | updateProperties () |
| | updateProperties Define or Delete IMU properties based on the connection status of the base device
|
| |
| bool | processNumber (const std::string &dev, const std::string &name, double values[], char *names[], int n) |
| | Process IMU number properties.
|
| |
| bool | processSwitch (const std::string &dev, const std::string &name, ISState *states, char *names[], int n) |
| | Process IMU switch properties.
|
| |
| bool | processText (const std::string &dev, const std::string &name, char *texts[], char *names[], int n) |
| | Process IMU text properties.
|
| |
| bool | saveConfigItems (FILE *fp) |
| | saveConfigItems Save IMU properties in config file
|
| |
| virtual bool | SetCalibrationStatus (int sys, int gyro, int accel, int mag) |
| | SetCalibrationStatus Set the calibration status for each sensor.
|
| |
| virtual bool | SetDeviceInfo (const std::string &chipID, const std::string &firmwareVersion, const std::string &sensorStatus) |
| | SetDeviceInfo Set chip ID, firmware version, and sensor status.
|
| |
| virtual bool | SetTemperature (double temperature) |
| | SetTemperature Set the internal chip temperature.
|
| |
| virtual bool | SetStabilityMonitoring (double vibrationLevel, double stabilityThreshold) |
| | SetStabilityMonitoring Set vibration level and alert threshold.
|
| |
Public Member Functions inherited from INDI::DefaultDevice