Top-level namespace containing all of DLAPI. More...

Namespaces
namespace	ErrorFlags
	Contains Error flags/masks for a variety of peripherals/devices, as reported by the camera.

namespace	PulseGuideStatus
	Status flags for the pulse guide port.

namespace	V1

namespace	V2

Classes
class	IAO
	AO Interface Class. More...

class	ICamera
	Camera interface class. More...

class	IDebugControl
	An abstract interface that gives users access to debug logging controls \seealso IGateway, getGateway() If Debug logging is supported, the IGateway pointer returned from getGateway() will inheritt from IDebugControl as well. You can check to see whether the version of DLAPI being used by your application supports these features using a dynamic cast: More...

class	IFW
	FW Interface Class. More...

class	IFWExtended

class	IGateway
	Gateway object for controlling device discovery, and lifetime management. More...

class	IImage
	Interface to an DLAPI Image buffer. More...

class	IImageExt

class	IPromise
	Promise interface class. More...

class	ISensor
	Sensor Interface Class. More...

class	ITEC
	TEC interface class. More...

struct	TConnectionDetails
	Network connection detail structure. More...

struct	TExposureOptions
	A collection of exposure parameters required for starting an exposure. More...

struct	TImageMetadata
	A collection of metadata associated with an image. More...

struct	TLayerMetadata

struct	TNetworkSettings
	A collection of wireless network configuration settings. More...

struct	TSubframe
	A collection of frame parameters, required for specifying the dimensions of an image. More...

Typedefs
using	FilterType = EFilterType

typedef IImage *	IImagePtr
	Convenience typedef for IImage pointers.

typedef IImageExt *	IImageExtPtr

typedef IPromise *	IPromisePtr
	Convenience typedef for IPromise pointers.

typedef ITEC *	ITECPtr
	Convenience typedef for ITEC pointers.

typedef IAO *	IAOPtr
	Convenience typedef for IAO pointers.

typedef IFW *	IFWPtr
	Convenience typedef for IFW pointers.

typedef IFWExtended *	IFWExtendedPtr

typedef ISensor *	ISensorPtr
	Convenience typedef for ISensor pointers.

typedef ICamera *	ICameraPtr
	Convenience typedef for ICamera pointers.

typedef IGateway *	IGatewayPtr
	Convenience typedef for IGateway pointers.

Enumerations
enum	EStatusCode { Success = 0 , ClientError = 0x01 , InvalidSoh = ClientError , InvalidHeaderType , InvalidBodyType , InvalidFooterType , InvalidSensorId , InvalidMessageLength , InvalidParameter , UnsupportedBodyType , BadChecksum , DeviceError = 0x80 , DeviceBusy , ExposureInProgress = DeviceBusy , ReadoutInProgress = DeviceBusy , ImageNotAvailable , FeatureNotSupported , InvalidStatus = 0xff }
	Status codes returned by a camera with every message response. More...

enum	EPulseGuideDirection { North = 0 , South = 1 , East = 2 , West = 3 }
	Bases for pulse guiding. More...

enum	EFilterType { Monochrome , Color , SparseColor , InvalidFilterType = 0xff }

enum	EFrameType { Progressive , Interline , BayerInterline , RollingShutter , GlobalShutter , InvalidFrameType = 0xff }
	Sensor's readout frame typeid. More...

enum	EShutterStatus { ShutterClosed = 0 , ShutterOpen , ShutterClosing , ShutterOpening , ShutterRolling , ShutterExercising , ShutterError , ShutterUninitialized = 0xFF }
	Status of sensor's shutter. More...

enum	ENetworkMode { AdHoc = 0 , Open = 1 , WEP = 2 , WPA = 3 , WPA2 = 4 , InvalidNetworkMode = 0xff }
	Network Connection type/security for WiFi operation. More...

enum	EEndpointType { Net = 1 , USB = 2 , USB3 = 3 , RAW = 4 , EndpointTypeCount , LastEndpointType = EndpointTypeCount - 1 , FirstEndpointType = Net , InvalidEndpoint = 0xff }
	Camera's connection endpoint type (networked, USB, etc) More...

Functions
DL_API IGatewayPtr MYCDECL	getGateway ()
	Returns a pointer to an instance of a Gateway object, or (if one exists) return the existing pointer to it.

DL_API void MYCDECL	deleteGateway (IGatewayPtr)
	Decrement the internal count of IGateway pointers supplied, and delete the active IGateway instance when it is no longer in use.

Detailed Description

Top-level namespace containing all of DLAPI.

The dl namespace contains all the interface and utility definitions you will need while controlling a DLAPI compliant camera. Classes prefixed with a capital "I" (such as IGateway, ICamera, or IImage) represent abstract interface classes that are instantiated by DLAPI. They are grouped by function:

Discovery/management of devices (IGateway)
Camera/peripheral control (ICamera, ISensor, ITEC, IFW, and IAO)
Image buffer/metadata storage/transport (IImage)
Asynchronous command monitoring/error reporting (IPromise)

Interface classes all have convenience pointer typedefs (e.g. ICameraPtr is ICamera*), to ease readability.

In addition to the interface classes, there are a number of different parametrization and data structures both contained within interfaces (such as the ICamera::Info structure), and without (such as the TExposureOptions structure). These structures are used to transport large data structures to and from the API, and provides some degree of structure and modularity to the API.

Typedef Documentation

◆ FilterType

using dl::FilterType = EFilterType

◆ IAOPtr

typedef IAO* dl::IAOPtr

Convenience typedef for IAO pointers.

◆ ICameraPtr

typedef ICamera* dl::ICameraPtr

Convenience typedef for ICamera pointers.

◆ IFWExtendedPtr

typedef IFWExtended* dl::IFWExtendedPtr

◆ IFWPtr

typedef IFW* dl::IFWPtr

Convenience typedef for IFW pointers.

◆ IGatewayPtr

typedef IGateway* dl::IGatewayPtr

Convenience typedef for IGateway pointers.

◆ IImageExtPtr

typedef IImageExt* dl::IImageExtPtr

◆ IImagePtr

typedef IImage* dl::IImagePtr

Convenience typedef for IImage pointers.

◆ IPromisePtr

typedef IPromise* dl::IPromisePtr

Convenience typedef for IPromise pointers.

◆ ISensorPtr

typedef ISensor* dl::ISensorPtr

Convenience typedef for ISensor pointers.

◆ ITECPtr

typedef ITEC* dl::ITECPtr

Convenience typedef for ITEC pointers.

Enumeration Type Documentation

◆ EEndpointType

enum dl::EEndpointType

Camera's connection endpoint type (networked, USB, etc)

Enumerator
Net	A UDP over Ethernet/WiFi endpoint.
USB	A USB endpoint.
USB3	A USB3.0 endpoint.
RAW	A direct-connect interface for raw I/O over Ethernet II Frames.
EndpointTypeCount	A convenience definition for determining the number of endpoint types.
LastEndpointType	A convenience definition for determining the last endpoint type.
FirstEndpointType	A convenience definition for determining the first endpoint type.
InvalidEndpoint	The endpoint is either invalid, or uninitialized.

                       {
        Net = 1, 
        USB = 2, 
        USB3 = 3, 
        RAW = 4, 
 
        EndpointTypeCount,                          
        LastEndpointType = EndpointTypeCount - 1,   
        FirstEndpointType = Net,                    
        InvalidEndpoint = 0xff,                     
    };

◆ EFilterType

enum dl::EFilterType

Enumerator
Monochrome	Monochrome filter on sensor.
Color	Bayer color filter on sensor.
SparseColor	TrueSense Sparse Color filter on sensor.
InvalidFilterType	Filter type is invalid or uninitialized.

    {
        Monochrome,                 
        Color,                      
        SparseColor,                
        InvalidFilterType = 0xff,   
    };

◆ EFrameType

enum dl::EFrameType

Sensor's readout frame typeid.

Enumerator
Progressive	Progressive, full-frame sensor.
Interline	Interline sensor.
BayerInterline	Bayer/SparseColor interline sensors.
RollingShutter	Rolling Shutter for CMOS sensors.
GlobalShutter	Global Shutter for CMOS sensors.
InvalidFrameType	Frame type is invalid or uninitialized.

    {
        Progressive,                
        Interline,                  
        BayerInterline,             
        RollingShutter,             
        GlobalShutter,              
        InvalidFrameType = 0xff,    
    };

◆ ENetworkMode

enum dl::ENetworkMode

Network Connection type/security for WiFi operation.

Enumerator
AdHoc	Use an ad-hoc network. More details coming.
Open	Connect to an open network specified via ICamera::setNetworkSettings(), retrieved using ICamera::getNetworkSettings().
WEP	Connect to a WEP secured network specified via ICamera::setNetworkSettings(), retrieved using ICamera::getNetworkSettings().
WPA	Connect to a WPA 1 secured network specified via ICamera::setNetworkSettings(), retrieved using ICamera::getNetworkSettings().
WPA2	Connect to a WPA 2 secured network specified via ICamera::setNetworkSettings(), retrieved using ICamera::getNetworkSettings().
InvalidNetworkMode	Network mode is either invalid, or uninitialized.

    {
        AdHoc = 0,  
        Open = 1,   
        WEP = 2,    
        WPA = 3,    
        WPA2 = 4,   
        InvalidNetworkMode = 0xff   
    };

◆ EPulseGuideDirection

enum dl::EPulseGuideDirection

Bases for pulse guiding.

See also: ICamera::PulseGuide

Enumerator
North	North (+ declination/altitude)
South	South (- declination/altitude)
East	East (+ right ascension/azimuth)
West	West (- right ascension/azimuth)

    {
        North = 0,  
        South = 1,  
        East = 2,   
        West = 3,   
    };

◆ EShutterStatus

enum dl::EShutterStatus

Status of sensor's shutter.

Enumerator
ShutterClosed	Shutter is closed.
ShutterOpen	Shutter is open.
ShutterClosing	Shutter is moving to closed state.
ShutterOpening	Shutter is moving to opened state.
ShutterRolling	for future use in Aluma Pro.
ShutterExercising	Shutter is in exercising state, more details coming.
ShutterError	for future use in Aluma Pro
ShutterUninitialized	Shutter state is uninitialized.

    {
        ShutterClosed = 0,  
        ShutterOpen,        
        ShutterClosing,     
        ShutterOpening,     
        ShutterRolling,     
        ShutterExercising,  
        ShutterError,       
 
        ShutterUninitialized = 0xFF 
    };

◆ EStatusCode

enum dl::EStatusCode

Status codes returned by a camera with every message response.

Enumerator
Success	Device reports command executed successfully, and without error.
ClientError	Start of client-side error codes.
InvalidSoh	Invalid message start-of-header byte.
InvalidHeaderType	Invalid header typeid supplied in request.
InvalidBodyType	Invalid body typeid supplied in request.
InvalidFooterType	Invalid footer typeid supplied in request.
InvalidSensorId	Invalid sensor ID number supplied in request.
InvalidMessageLength	Invalid message length supplied in request.
InvalidParameter	Invalid parameter passed in request body.
UnsupportedBodyType	Invalid/unsupported body type supplied in request header.
BadChecksum	Message with CRC checksum failed validation. Resend message.
DeviceError	Start of device-side error codes.
DeviceBusy	Catch-all for device busy errors.
ExposureInProgress	Device has an exposure in progress and cannot comply [[deprecated]].
ReadoutInProgress	Device has a frame readout in progress and cannot comply [[deprecated]].
ImageNotAvailable	Image Transfer was requested, but no image is ready for download
FeatureNotSupported	Camera does not support the requested feature. See also ICamera::Capability, ICamera::getCapability(), ICamera::queryCapability()
InvalidStatus	Unknown status response from camera.

    {
        Success = 0,                
 
        // client specific errors ...
        ClientError = 0x01,         
        InvalidSoh = ClientError,   
        InvalidHeaderType,          
        InvalidBodyType,            
        InvalidFooterType,          
        InvalidSensorId,            
        InvalidMessageLength,       
        InvalidParameter,           
        UnsupportedBodyType,        
        BadChecksum,                
 
        // device specific errors ... 
        DeviceError = 0x80,                 
        DeviceBusy,                         
        ExposureInProgress = DeviceBusy,    
        ReadoutInProgress = DeviceBusy,     
        ImageNotAvailable,                  
        FeatureNotSupported,                
 
        // Book keeping
        InvalidStatus = 0xff 
    };

Function Documentation

◆ deleteGateway()

DL_API void MYCDECL dl::deleteGateway ( IGatewayPtr )

Decrement the internal count of IGateway pointers supplied, and delete the active IGateway instance when it is no longer in use.

Parameters

IGatewayPtr a pointer to an IGateway object to delete.

See also: IGateway, getGateway()

This function tracks usage counts of getGateway(), and deletes the singleton instance of IGateway when the last instance is released.

◆ getGateway()

DL_API IGatewayPtr MYCDECL dl::getGateway ( )

Returns a pointer to an instance of a Gateway object, or (if one exists) return the existing pointer to it.

Returns: IGatewayPtr pointer to the instance of the process' IGateway.

See also: IGateway, deleteGateway()

This function provides the user with the singleton instance of the DLAPI IGateway for the process. Use this function to gain access to all DLAPI devices. Minimize the number of calls to this function if at all possible. It is not necessary to keep an IGateway instance active throughout the lifetime of your application, but you should avoid creating gateways at call sites. Keep the gateway instances alive throughout the scope of all communications with the API. All calls to dl::getGateway() should be accompanied by a call to dl::deleteGateway().

An easy way to ensure this occurs is to create a smart pointer with a custom deleter that handles this cleanup.

Namespaces

Classes

Typedefs

Enumerations

Functions