diff --git a/pkg/alpacago/alpaca.go b/pkg/alpacago/alpaca.go index f8c67ca..7df0b07 100644 --- a/pkg/alpacago/alpaca.go +++ b/pkg/alpacago/alpaca.go @@ -51,22 +51,22 @@ func NewAlpacaAPI(clientId uint32, secure bool, domain string, ip string, port i } /* - getQueryString() +getQueryString() - Many ASCOM methods require parameter values. All methods - that use the HTTP GET verb should include parameters as - query string name-value pairs. +Many ASCOM methods require parameter values. All methods +that use the HTTP GET verb should include parameters as +query string name-value pairs. */ func (a *ASCOMAlpacaAPIClient) getQueryString() string { return fmt.Sprintf("ClientID=%d&ClientTransactionID=%d", a.ClientId, a.TransactionId) } /* - getEndpoint() +getEndpoint() - Alpaca Device API URLs are of the form http(s)://host:port/path - where path comprises "/api/v1/" followed by one of the ASCOM - method from https://ascom-standards.org/api/ +Alpaca Device API URLs are of the form http(s)://host:port/path +where path comprises "/api/v1/" followed by one of the ASCOM +method from https://ascom-standards.org/api/ */ func (a *ASCOMAlpacaAPIClient) getEndpoint(deviceType string, deviceNumber uint, method string) string { return fmt.Sprintf("%s/api/v1/%s/%d/%s", a.UrlBase, deviceType, deviceNumber, method) @@ -81,9 +81,9 @@ type stringResponse struct { } /* - GetStringResponse() +GetStringResponse() - Global public method to work with calls returning stringResponse +Global public method to work with calls returning stringResponse */ func (a *ASCOMAlpacaAPIClient) GetStringResponse(deviceType string, deviceNumber uint, method string) (string, error) { // Build the ASCOM endpoint: @@ -117,9 +117,9 @@ type stringlistResponse struct { } /* - GetStringListResponse() +GetStringListResponse() - Global public method to work with calls returning stringListResponse +Global public method to work with calls returning stringListResponse */ func (a *ASCOMAlpacaAPIClient) GetStringListResponse(deviceType string, deviceNumber uint, method string) ([]string, error) { // Build the ASCOM endpoint: @@ -152,9 +152,9 @@ type booleanResponse struct { } /* - GetBooleanResponse() +GetBooleanResponse() - Global public method to work with calls returning booleanResponse +Global public method to work with calls returning booleanResponse */ func (a *ASCOMAlpacaAPIClient) GetBooleanResponse(deviceType string, deviceNumber uint, method string) (bool, error) { // Build the ASCOM endpoint: @@ -187,9 +187,9 @@ type float64Response struct { } /* - GetFloat64Response() +GetFloat64Response() - Global public method to work with calls returning float64Response +Global public method to work with calls returning float64Response */ func (a *ASCOMAlpacaAPIClient) GetFloat64Response(deviceType string, deviceNumber uint, method string) (float64, error) { // Build the ASCOM endpoint: @@ -222,9 +222,9 @@ type int32Response struct { } /* - GetInt32Response() +GetInt32Response() - Global public method to work with calls returning int32Response +Global public method to work with calls returning int32Response */ func (a *ASCOMAlpacaAPIClient) GetInt32Response(deviceType string, deviceNumber uint, method string) (int32, error) { // Build the ASCOM endpoint: @@ -257,9 +257,9 @@ type uint32listResponse struct { } /* - GetInt32ListResponse() +GetInt32ListResponse() - Global public method to work with calls returning int32listResponse +Global public method to work with calls returning int32listResponse */ func (a *ASCOMAlpacaAPIClient) GetUInt32ListResponse(deviceType string, deviceNumber uint, method string) ([]uint32, error) { // Build the ASCOM endpoint: @@ -293,9 +293,9 @@ type uint32Rank2ArrayResponse struct { } /* - GetUInt32RankArrayResponse() +GetUInt32RankArrayResponse() - Global public method to work with calls returning a uint32Rank2ArrayResponse +Global public method to work with calls returning a uint32Rank2ArrayResponse */ func (a *ASCOMAlpacaAPIClient) GetUInt32Rank2ArrayResponse(deviceType string, deviceNumber uint, method string) ([][]uint32, uint32, error) { // Build the ASCOM endpoint: @@ -355,76 +355,76 @@ func (a *ASCOMAlpacaAPIClient) Put(deviceType string, deviceNumber uint, method } /* - IsConnected() common method to all ASCOM Alpaca compliant devices +IsConnected() common method to all ASCOM Alpaca compliant devices - @returns the connection status of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected +@returns the connection status of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected */ func (a *ASCOMAlpacaAPIClient) IsConnected(deviceType string, deviceNumber uint) (bool, error) { return a.GetBooleanResponse(deviceType, deviceNumber, "connected") } /* - GetDescription() common method to all ASCOM Alpaca compliant devices +GetDescription() common method to all ASCOM Alpaca compliant devices - @returns the description of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__description +@returns the description of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__description */ func (a *ASCOMAlpacaAPIClient) GetDescription(deviceType string, deviceNumber uint) (string, error) { return a.GetStringResponse(deviceType, deviceNumber, "description") } /* - GetDriverInfo() common method to all ASCOM Alpaca compliant devices +GetDriverInfo() common method to all ASCOM Alpaca compliant devices - @returns the description of the driver - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__driverinfo +@returns the description of the driver +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__driverinfo */ func (a *ASCOMAlpacaAPIClient) GetDriverInfo(deviceType string, deviceNumber uint) (string, error) { return a.GetStringResponse(deviceType, deviceNumber, "driverinfo") } /* - GetDriverVersion() common method to all ASCOM Alpaca compliant devices +GetDriverVersion() common method to all ASCOM Alpaca compliant devices - @returns a string containing only the major and minor version of the driver. - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__driverversion +@returns a string containing only the major and minor version of the driver. +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__driverversion */ func (a *ASCOMAlpacaAPIClient) GetDriverVersion(deviceType string, deviceNumber uint) (string, error) { return a.GetStringResponse(deviceType, deviceNumber, "driverversion") } /* - GetInterfaceVersion() common method to all ASCOM Alpaca compliant devices - - @returns the version of the ASCOM device interface contract to which - this device complies. Only one interface version is current at a - moment in time and all new devices should be built to the latest - interface version. Applications can choose which device interface - versions they support and it is in their interest to support previous - versions as well as the current version to ensure thay can use the - largest number of devices. - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__interfaceversion +GetInterfaceVersion() common method to all ASCOM Alpaca compliant devices + +@returns the version of the ASCOM device interface contract to which +this device complies. Only one interface version is current at a +moment in time and all new devices should be built to the latest +interface version. Applications can choose which device interface +versions they support and it is in their interest to support previous +versions as well as the current version to ensure thay can use the +largest number of devices. +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__interfaceversion */ func (a *ASCOMAlpacaAPIClient) GetInterfaceVersion(deviceType string, deviceNumber uint) (int32, error) { return a.GetInt32Response(deviceType, deviceNumber, "interfaceversion") } /* - GetName() common method to all ASCOM Alpaca compliant devices +GetName() common method to all ASCOM Alpaca compliant devices - @returns the name of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__name +@returns the name of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__name */ func (a *ASCOMAlpacaAPIClient) GetName(deviceType string, deviceNumber uint) (string, error) { return a.GetStringResponse(deviceType, deviceNumber, "name") } /* - GetSupportedActions() common method to all ASCOM Alpaca compliant devices +GetSupportedActions() common method to all ASCOM Alpaca compliant devices - @returns the list of action names supported by this driver. - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__supportedactions +@returns the list of action names supported by this driver. +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__supportedactions */ func (a *ASCOMAlpacaAPIClient) GetSupportedActions(deviceType string, deviceNumber uint) ([]string, error) { return a.GetStringListResponse(deviceType, deviceNumber, "supportedactions") diff --git a/pkg/alpacago/calibrator.go b/pkg/alpacago/calibrator.go index 5512143..f8efe23 100644 --- a/pkg/alpacago/calibrator.go +++ b/pkg/alpacago/calibrator.go @@ -53,21 +53,21 @@ func NewCoverCalibrator(clientId uint32, secure bool, domain string, ip string, } /* - IsConnected() common method to all ASCOM Alpaca compliant devices +IsConnected() common method to all ASCOM Alpaca compliant devices - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected */ func (c *CoverCalibrator) IsConnected() (bool, error) { return c.Alpaca.GetBooleanResponse("covercalibrator", c.DeviceNumber, "connected") } /* - SetConnected() common method to all ASCOM Alpaca compliant devices +SetConnected() common method to all ASCOM Alpaca compliant devices - @param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected +@param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected */ func (c *CoverCalibrator) SetConnected(connected bool) error { c.Alpaca.TransactionId++ @@ -83,21 +83,21 @@ func (c *CoverCalibrator) SetConnected(connected bool) error { } /* - GetBrightness() +GetBrightness() - @returns the current calibrator brightness in the range 0 (completely off) to MaxBrightness (fully on) - @see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/get_covercalibrator__device_number__brightness +@returns the current calibrator brightness in the range 0 (completely off) to MaxBrightness (fully on) +@see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/get_covercalibrator__device_number__brightness */ func (c *CoverCalibrator) GetBrightness() (float64, error) { return c.Alpaca.GetFloat64Response("covercalibrator", c.DeviceNumber, "brightness") } /* - GetStatus() +GetStatus() - @returns the state of the calibration device, if present, otherwise returns "NotPresent". The calibrator state mode is specified as an integer value from the CalibratorStatus Enum. - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__calibratorstate - @see https://ascom-standards.org/Help/Platform/html/T_ASCOM_DeviceInterface_CalibratorStatus.htm +@returns the state of the calibration device, if present, otherwise returns "NotPresent". The calibrator state mode is specified as an integer value from the CalibratorStatus Enum. +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__calibratorstate +@see https://ascom-standards.org/Help/Platform/html/T_ASCOM_DeviceInterface_CalibratorStatus.htm */ func (c *CoverCalibrator) GetStatus() (CalibratorState, error) { status, err := c.Alpaca.GetInt32Response("covercalibrator", c.DeviceNumber, "calibratorstate") @@ -105,11 +105,11 @@ func (c *CoverCalibrator) GetStatus() (CalibratorState, error) { } /* - GetCoverStatus() +GetCoverStatus() - @returns the state of the device cover, if present, otherwise returns "NotPresent". The cover state mode is specified as an integer value from the CoverStatus Enum. - @see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/get_covercalibrator__device_number__coverstate - @see https://ascom-standards.org/Help/Platform/html/T_ASCOM_DeviceInterface_CoverStatus.htm +@returns the state of the device cover, if present, otherwise returns "NotPresent". The cover state mode is specified as an integer value from the CoverStatus Enum. +@see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/get_covercalibrator__device_number__coverstate +@see https://ascom-standards.org/Help/Platform/html/T_ASCOM_DeviceInterface_CoverStatus.htm */ func (c *CoverCalibrator) GetCoverStatus() (CoverState, error) { status, err := c.Alpaca.GetInt32Response("covercalibrator", c.DeviceNumber, "coverstate") @@ -117,20 +117,20 @@ func (c *CoverCalibrator) GetCoverStatus() (CoverState, error) { } /* - GetMaxBrightness() +GetMaxBrightness() - @returns the brightness value that makes the calibrator deliver its maximum illumination. - @see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/get_covercalibrator__device_number__maxbrightness +@returns the brightness value that makes the calibrator deliver its maximum illumination. +@see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/get_covercalibrator__device_number__maxbrightness */ func (c *CoverCalibrator) GetMaxBrightness() (int32, error) { return c.Alpaca.GetInt32Response("covercalibrator", c.DeviceNumber, "maxbrightness") } /* - SetCalibratorOn() +SetCalibratorOn() - @returns and error, or nil, if nil the calibrator on if the device has calibration capability. - @see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/put_covercalibrator__device_number__calibratoron +@returns and error, or nil, if nil the calibrator on if the device has calibration capability. +@see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/put_covercalibrator__device_number__calibratoron */ func (c *CoverCalibrator) SetCalibratorOn(brightness int32) error { c.Alpaca.TransactionId++ @@ -146,10 +146,10 @@ func (c *CoverCalibrator) SetCalibratorOn(brightness int32) error { } /* - SetCalibratorOff() +SetCalibratorOff() - @turns the calibrator off if the device has calibration capability. - @see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/put_covercalibrator__device_number__calibratoroff +@turns the calibrator off if the device has calibration capability. +@see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/put_covercalibrator__device_number__calibratoroff */ func (c *CoverCalibrator) SetCalibratorOff() error { c.Alpaca.TransactionId++ @@ -163,10 +163,10 @@ func (c *CoverCalibrator) SetCalibratorOff() error { } /* - CloseCover() +CloseCover() - @returns and error, or nil, if nil initiates cover closing if a cover is present. - @see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/put_covercalibrator__device_number__closecover +@returns and error, or nil, if nil initiates cover closing if a cover is present. +@see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/put_covercalibrator__device_number__closecover */ func (c *CoverCalibrator) CloseCover() error { c.Alpaca.TransactionId++ @@ -180,10 +180,10 @@ func (c *CoverCalibrator) CloseCover() error { } /* - HaltCover() +HaltCover() - @returns and error, or nil, if nil stops any cover movement that may be in progress if a cover is present and cover movement can be interrupted. - @see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/put_covercalibrator__device_number__haltcover +@returns and error, or nil, if nil stops any cover movement that may be in progress if a cover is present and cover movement can be interrupted. +@see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/put_covercalibrator__device_number__haltcover */ func (c *CoverCalibrator) HaltCover() error { c.Alpaca.TransactionId++ @@ -197,10 +197,10 @@ func (c *CoverCalibrator) HaltCover() error { } /* - OpenCover() +OpenCover() - @returns and error, or nil, if nil initiates cover opening if a cover is present. - @see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/put_covercalibrator__device_number__opencover +@returns and error, or nil, if nil initiates cover opening if a cover is present. +@see https://ascom-standards.org/api/#/CoverCalibrator%20Specific%20Methods/put_covercalibrator__device_number__opencover */ func (c *CoverCalibrator) OpenCover() error { c.Alpaca.TransactionId++ diff --git a/pkg/alpacago/camera.go b/pkg/alpacago/camera.go index 74a7623..56e5b8d 100644 --- a/pkg/alpacago/camera.go +++ b/pkg/alpacago/camera.go @@ -71,21 +71,21 @@ func NewCamera(clientId uint32, secure bool, domain string, ip string, port int3 } /* - IsConnected() common method to all ASCOM Alpaca compliant devices +IsConnected() common method to all ASCOM Alpaca compliant devices - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected */ func (c *Camera) IsConnected() (bool, error) { return c.Alpaca.GetBooleanResponse("camera", c.DeviceNumber, "connected") } /* - SetConnected() common method to all ASCOM Alpaca compliant devices +SetConnected() common method to all ASCOM Alpaca compliant devices - @param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected +@param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected */ func (c *Camera) SetConnected(connected bool) error { c.Alpaca.TransactionId++ @@ -101,40 +101,40 @@ func (c *Camera) SetConnected(connected bool) error { } /* - GetBayerOffsetX() +GetBayerOffsetX() - @returns the X offset of the Bayer matrix, as defined in SensorType. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__bayeroffsetx +@returns the X offset of the Bayer matrix, as defined in SensorType. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__bayeroffsetx */ func (c *Camera) GetBayerOffsetX() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "bayeroffsetx") } /* - GetBayerOffsetY() +GetBayerOffsetY() - @returns the Y offset of the Bayer matrix, as defined in SensorType. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__bayeroffsety +@returns the Y offset of the Bayer matrix, as defined in SensorType. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__bayeroffsety */ func (c *Camera) GetBayerOffsetY() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "bayeroffsety") } /* - GetBinX() +GetBinX() - @returns the binning factor for the X axis. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__binx +@returns the binning factor for the X axis. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__binx */ func (c *Camera) GetBinX() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "binx") } /* - SetBinX() +SetBinX() - @returns an error or nil, if nil it sets the binning factor for the X axis. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__binx +@returns an error or nil, if nil it sets the binning factor for the X axis. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__binx */ func (c *Camera) SetBinX(binX int32) error { c.Alpaca.TransactionId++ @@ -149,20 +149,20 @@ func (c *Camera) SetBinX(binX int32) error { } /* - GetBinY() +GetBinY() - @returns the binning factor for the Y axis. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__biny +@returns the binning factor for the Y axis. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__biny */ func (c *Camera) GetBinY() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "biny") } /* - SetBinY() +SetBinY() - @returns an error or nil, if nil it sets the binning factor for the Y axis. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__biny +@returns an error or nil, if nil it sets the binning factor for the Y axis. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__biny */ func (c *Camera) SetBinY(binY int32) error { c.Alpaca.TransactionId++ @@ -177,11 +177,11 @@ func (c *Camera) SetBinY(binY int32) error { } /* - GetOperationalState() +GetOperationalState() - @returns the current camera operational state (CameraIdle, CameraWaiting, CameraExposing, CameraReading, CameraDownload, CameraError) - The operational state is specified as an integer value from the OperationalState Enum. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__camerastate +@returns the current camera operational state (CameraIdle, CameraWaiting, CameraExposing, CameraReading, CameraDownload, CameraError) +The operational state is specified as an integer value from the OperationalState Enum. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__camerastate */ func (c *Camera) GetOperationalState() (OperationalState, error) { state, err := c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "camerastate") @@ -189,120 +189,120 @@ func (c *Camera) GetOperationalState() (OperationalState, error) { } /* - GetCCDSizeX() +GetCCDSizeX() - @returns the width of the CCD camera chip in unbinned pixels. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__cameraxsize +@returns the width of the CCD camera chip in unbinned pixels. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__cameraxsize */ func (c *Camera) GetCCDSizeX() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "cameraxsize") } /* - GetCCDSizeY() +GetCCDSizeY() - @returns the width of the CCD camera chip in unbinned pixels. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__cameraysize +@returns the width of the CCD camera chip in unbinned pixels. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__cameraysize */ func (c *Camera) GetCCDSizeY() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "cameraysize") } /* - CanAbortExposure() +CanAbortExposure() - @returns true if the camera can abort exposures; false if not. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__canabortexposure +@returns true if the camera can abort exposures; false if not. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__canabortexposure */ func (c *Camera) CanAbortExposure() (bool, error) { return c.Alpaca.GetBooleanResponse("camera", c.DeviceNumber, "canabortexposure") } /* - CanFastReadout() +CanFastReadout() - @returns true if the camera has a fast readout mode. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__canfastreadout +@returns true if the camera has a fast readout mode. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__canfastreadout */ func (c *Camera) CanFastReadout() (bool, error) { return c.Alpaca.GetBooleanResponse("camera", c.DeviceNumber, "canfastreadout") } /* - CanAsymmetricBin() +CanAsymmetricBin() - @returns true if the camera supports asymmetric binning - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__canasymmetricbin +@returns true if the camera supports asymmetric binning +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__canasymmetricbin */ func (c *Camera) CanAsymmetricBin() (bool, error) { return c.Alpaca.GetBooleanResponse("camera", c.DeviceNumber, "canasymmetricbin") } /* - CanGetCoolerPower() +CanGetCoolerPower() - @returns true if the camera's cooler power setting can be read. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__cangetcoolerpower +@returns true if the camera's cooler power setting can be read. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__cangetcoolerpower */ func (c *Camera) CanGetCoolerPower() (bool, error) { return c.Alpaca.GetBooleanResponse("camera", c.DeviceNumber, "cangetcoolerpower") } /* - CanPulseGuide() +CanPulseGuide() - @returns true if the camera supports pulse guiding. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__canpulseguide +@returns true if the camera supports pulse guiding. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__canpulseguide */ func (c *Camera) CanPulseGuide() (bool, error) { return c.Alpaca.GetBooleanResponse("camera", c.DeviceNumber, "canpulseguide") } /* - CanSetCCDTemperature() +CanSetCCDTemperature() - @returns true if the camera supports setting the CCD temperature. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__cansetccdtemperature +@returns true if the camera supports setting the CCD temperature. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__cansetccdtemperature */ func (c *Camera) CanSetCCDTemperature() (bool, error) { return c.Alpaca.GetBooleanResponse("camera", c.DeviceNumber, "cansetccdtemperature") } /* - CanStopExposure() +CanStopExposure() - @returns true if the camera can stop an exposure that is in progress - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__canstopexposure +@returns true if the camera can stop an exposure that is in progress +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__canstopexposure */ func (c *Camera) CanStopExposure() (bool, error) { return c.Alpaca.GetBooleanResponse("camera", c.DeviceNumber, "canstopexposure") } /* - GetCCDTemperature() +GetCCDTemperature() - @returns true if the camera can stop an exposure that is in progress - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__ccdtemperature +@returns true if the camera can stop an exposure that is in progress +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__ccdtemperature */ func (c *Camera) GetCCDTemperature() (float64, error) { return c.Alpaca.GetFloat64Response("camera", c.DeviceNumber, "ccdtemperature") } /* - IsCoolerOn() +IsCoolerOn() - @returns true if the camera cooler is one, else false - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__cooleron +@returns true if the camera cooler is one, else false +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__cooleron */ func (c *Camera) IsCoolerOn() (bool, error) { return c.Alpaca.GetBooleanResponse("camera", c.DeviceNumber, "cooleron") } /* - TurnCoolerOn() +TurnCoolerOn() - @returns error if there was a problem turning the cooler on - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__cooleron +@returns error if there was a problem turning the cooler on +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__cooleron */ func (c *Camera) TurnCoolerOn() error { c.Alpaca.TransactionId++ @@ -318,10 +318,10 @@ func (c *Camera) TurnCoolerOn() error { } /* - TurnCoolerOff() +TurnCoolerOff() - @returns error if there was a problem turning the cooler off - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__cooleron +@returns error if there was a problem turning the cooler off +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__cooleron */ func (c *Camera) TurnCoolerOff() error { c.Alpaca.TransactionId++ @@ -337,91 +337,91 @@ func (c *Camera) TurnCoolerOff() error { } /* - GetCoolerPowerLevel() +GetCoolerPowerLevel() - @returns the present cooler power level, in percent. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__coolerpower +@returns the present cooler power level, in percent. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__coolerpower */ func (c *Camera) GetCoolerPowerLevel() (float64, error) { return c.Alpaca.GetFloat64Response("camera", c.DeviceNumber, "coolerpower") } /* - GetGainInElectronsPerADUnit() +GetGainInElectronsPerADUnit() - @returns the gain of the camera in photoelectrons per A/D unit. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__electronsperadu +@returns the gain of the camera in photoelectrons per A/D unit. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__electronsperadu */ func (c *Camera) GetGainInElectronsPerADUnit() (float64, error) { return c.Alpaca.GetFloat64Response("camera", c.DeviceNumber, "electronsperadu") } /* - GetExposure() +GetExposure() - @returns Returns an array of 32bit integers containing the pixel values from the last exposure. This - call can return either a 2 dimension (monochrome images) or 3 dimension (colour or multi-plane images) - array of size NumX * NumY or NumX * NumY * NumPlanes. Where applicable, the size of NumPlanes has - to be determined by inspection of the returned Array. +@returns Returns an array of 32bit integers containing the pixel values from the last exposure. This +call can return either a 2 dimension (monochrome images) or 3 dimension (colour or multi-plane images) +array of size NumX * NumY or NumX * NumY * NumPlanes. Where applicable, the size of NumPlanes has +to be determined by inspection of the returned Array. - Since 32bit integers are always returned by this call, the returned JSON Type value (0 = Unknown, 1 = short(16bit), - 2 = int(32bit), 3 = Double) is always 2. The number of planes is given in the returned Rank value. +Since 32bit integers are always returned by this call, the returned JSON Type value (0 = Unknown, 1 = short(16bit), +2 = int(32bit), 3 = Double) is always 2. The number of planes is given in the returned Rank value. - When de-serialising to an object it is essential to know the array Rank beforehand so that the correct data - class can be used. This can be achieved through a regular expression or by direct parsing of the returned - JSON string to extract the Type and Rank values before de-serialising. +When de-serialising to an object it is essential to know the array Rank beforehand so that the correct data +class can be used. This can be achieved through a regular expression or by direct parsing of the returned +JSON string to extract the Type and Rank values before de-serialising. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__imagearray +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__imagearray */ func (c *Camera) GetExposure() ([][]uint32, uint32, error) { return c.Alpaca.GetUInt32Rank2ArrayResponse("camera", c.DeviceNumber, "imagearray") } /* - GetExposureMax() +GetExposureMax() - @returns the maximum exposure time supported by StartExposure. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__exposuremax +@returns the maximum exposure time supported by StartExposure. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__exposuremax */ func (c *Camera) GetExposureMax() (float64, error) { return c.Alpaca.GetFloat64Response("camera", c.DeviceNumber, "exposuremax") } /* - GetExposureMin() +GetExposureMin() - @returns the maximum exposure time supported by StartExposure. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__exposuremin +@returns the maximum exposure time supported by StartExposure. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__exposuremin */ func (c *Camera) GetExposureMin() (float64, error) { return c.Alpaca.GetFloat64Response("camera", c.DeviceNumber, "exposuremin") } /* - GetExposureResolution() +GetExposureResolution() - @returns the smallest increment in exposure time supported by StartExposure. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__exposureresolution +@returns the smallest increment in exposure time supported by StartExposure. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__exposureresolution */ func (c *Camera) GetExposureResolution() (float64, error) { return c.Alpaca.GetFloat64Response("camera", c.DeviceNumber, "exposureresolution") } /* - IsFastReadoutEnabled() +IsFastReadoutEnabled() - @returns whenther Fast Readout Mode is enabled. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__fastreadout +@returns whenther Fast Readout Mode is enabled. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__fastreadout */ func (c *Camera) IsFastReadoutEnabled() (bool, error) { return c.Alpaca.GetBooleanResponse("camera", c.DeviceNumber, "fastreadout") } /* - EnableFastReadout() +EnableFastReadout() - @returns an error or nil, if nil it enables the fast readout mode - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__fastreadout +@returns an error or nil, if nil it enables the fast readout mode +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__fastreadout */ func (c *Camera) EnableFastReadout() error { c.Alpaca.TransactionId++ @@ -437,10 +437,10 @@ func (c *Camera) EnableFastReadout() error { } /* - DisableFastReadout() +DisableFastReadout() - @returns an error or nil, if nil it disables the fast readout mode - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__fastreadout +@returns an error or nil, if nil it disables the fast readout mode +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__fastreadout */ func (c *Camera) DisableFastReadout() error { c.Alpaca.TransactionId++ @@ -456,30 +456,30 @@ func (c *Camera) DisableFastReadout() error { } /* - GetFullWellCapacity() +GetFullWellCapacity() - @returns the full well capacity of the camera in electrons, at the current camera settings (binning, SetupDialog settings, etc.). - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__fullwellcapacity +@returns the full well capacity of the camera in electrons, at the current camera settings (binning, SetupDialog settings, etc.). +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__fullwellcapacity */ func (c *Camera) GetFullWellCapacity() (float64, error) { return c.Alpaca.GetFloat64Response("camera", c.DeviceNumber, "fullwellcapacity") } /* - GetGain() +GetGain() - @returns the camera's gain (GAIN VALUE MODE) OR the index of the selected camera gain description in the Gains array (GAINS INDEX MODE). - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__gain +@returns the camera's gain (GAIN VALUE MODE) OR the index of the selected camera gain description in the Gains array (GAINS INDEX MODE). +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__gain */ func (c *Camera) GetGain() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "gain") } /* - SetGain() +SetGain() - @returns an error or nil, if nil it sets the gain to the specified value. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__gain +@returns an error or nil, if nil it sets the gain to the specified value. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__gain */ func (c *Camera) SetGain(gain int32) error { c.Alpaca.TransactionId++ @@ -495,80 +495,80 @@ func (c *Camera) SetGain(gain int32) error { } /* - GetGainMax() +GetGainMax() - @returns the maximum value of Gain. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__gainmax +@returns the maximum value of Gain. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__gainmax */ func (c *Camera) GetGainMax() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "gainmax") } /* - GetGainMin() +GetGainMin() - @returns the minimum value of Gain. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__gainmin +@returns the minimum value of Gain. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__gainmin */ func (c *Camera) GetGainMin() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "gainmin") } /* - GetGains() +GetGains() - @returns the Gains supported by the camera. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__gains +@returns the Gains supported by the camera. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__gains */ func (c *Camera) GetGains() ([]string, error) { return c.Alpaca.GetStringListResponse("camera", c.DeviceNumber, "gains") } /* - HasShutter() +HasShutter() - @returns the true if this camera has a mechanical shutter. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__hasshutter +@returns the true if this camera has a mechanical shutter. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__hasshutter */ func (c *Camera) HasShutter() (bool, error) { return c.Alpaca.GetBooleanResponse("camera", c.DeviceNumber, "hasshutter") } /* - GetHeatSinkTemperature() +GetHeatSinkTemperature() - @returns the current heat sink temperature (called "ambient temperature" by some manufacturers) in degrees Celsius. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__heatsinktemperature +@returns the current heat sink temperature (called "ambient temperature" by some manufacturers) in degrees Celsius. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__heatsinktemperature */ func (c *Camera) GetHeatSinkTemperature() (float64, error) { return c.Alpaca.GetFloat64Response("camera", c.DeviceNumber, "heatsinktemperature") } /* - IsImageReady() +IsImageReady() - @returns true if the image is ready to be downloaded from the camera - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__imageready +@returns true if the image is ready to be downloaded from the camera +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__imageready */ func (c *Camera) IsImageReady() (bool, error) { return c.Alpaca.GetBooleanResponse("camera", c.DeviceNumber, "imageready") } /* - IsPulseGuiding() +IsPulseGuiding() - @returns true if the the camera is currrently in a PulseGuide operation. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__ispulseguiding +@returns true if the the camera is currrently in a PulseGuide operation. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__ispulseguiding */ func (c *Camera) IsPulseGuiding() (bool, error) { return c.Alpaca.GetBooleanResponse("camera", c.DeviceNumber, "ispulseguiding") } /* - GetLastExposureStartTime() +GetLastExposureStartTime() - @returns the actual exposure start in the FITS-standard CCYY-MM-DDThh:mm:ss[.sss...] format. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__lastexposurestarttime +@returns the actual exposure start in the FITS-standard CCYY-MM-DDThh:mm:ss[.sss...] format. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__lastexposurestarttime */ func (c *Camera) GetLastExposureStartTime() (*time.Time, error) { starttime, err := c.Alpaca.GetStringResponse("camera", c.DeviceNumber, "lastexposurestarttime") @@ -591,60 +591,60 @@ func (c *Camera) GetLastExposureStartTime() (*time.Time, error) { } /* - GetLastExposureDuration() +GetLastExposureDuration() - @returns the actual exposure duration in seconds (i.e. shutter open time). - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__lastexposureduration +@returns the actual exposure duration in seconds (i.e. shutter open time). +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__lastexposureduration */ func (c *Camera) GetLastExposureDuration() (float64, error) { return c.Alpaca.GetFloat64Response("camera", c.DeviceNumber, "lastexposureduration") } /* - GetMaxADU() +GetMaxADU() - @returns the maximum ADU value the camera can produce. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__maxadu +@returns the maximum ADU value the camera can produce. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__maxadu */ func (c *Camera) GetMaxADU() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "maxadu") } /* - GetMaxBinX() +GetMaxBinX() - @returns the maximum allowed binning for the X camera axis. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__maxbinx +@returns the maximum allowed binning for the X camera axis. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__maxbinx */ func (c *Camera) GetMaxBinX() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "maxbinx") } /* - GetMaxBinY() +GetMaxBinY() - @returns the maximum allowed binning for the Y camera axis. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__maxbiny +@returns the maximum allowed binning for the Y camera axis. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__maxbiny */ func (c *Camera) GetMaxBinY() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "maxbiny") } /* - GetSubFrameWidth() +GetSubFrameWidth() - @returns the current subframe width, if binning is active, value is in binned pixels. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__numx +@returns the current subframe width, if binning is active, value is in binned pixels. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__numx */ func (c *Camera) GetSubFrameWidth() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "numx") } /* - SetSubFrameWidth() +SetSubFrameWidth() - @returns an error or nil, if the subframe width can be set. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__numx +@returns an error or nil, if the subframe width can be set. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__numx */ func (c *Camera) SetSubFrameWidth(numX int32) error { c.Alpaca.TransactionId++ @@ -660,20 +660,20 @@ func (c *Camera) SetSubFrameWidth(numX int32) error { } /* - GetSubFrameHeight() +GetSubFrameHeight() - @returns the current subframe height, if binning is active, value is in binned pixels. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__numy +@returns the current subframe height, if binning is active, value is in binned pixels. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__numy */ func (c *Camera) GetSubFrameHeight() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "numy") } /* - SetSubFrameHeight() +SetSubFrameHeight() - @returns an error or nil, if the subframe height can be set. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__numy +@returns an error or nil, if the subframe height can be set. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__numy */ func (c *Camera) SetSubFrameHeight(numY int32) error { c.Alpaca.TransactionId++ @@ -689,51 +689,51 @@ func (c *Camera) SetSubFrameHeight(numY int32) error { } /* - GetCurrentOperationPercentageComplete() +GetCurrentOperationPercentageComplete() - @returns the percentage of the current operation that is complete. If valid, returns an integer between 0 and - 100, where 0 indicates 0% progress (function just started) and 100 indicates 100% progress (i.e. completion). - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__percentcompleted +@returns the percentage of the current operation that is complete. If valid, returns an integer between 0 and +100, where 0 indicates 0% progress (function just started) and 100 indicates 100% progress (i.e. completion). +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__percentcompleted */ func (c *Camera) GetCurrentOperationPercentageComplete() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "percentcompleted") } /* - GetPixelSizeX() +GetPixelSizeX() - @returns the width of the CCD chip pixels in microns. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__pixelsizex +@returns the width of the CCD chip pixels in microns. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__pixelsizex */ func (c *Camera) GetPixelSizeX() (float64, error) { return c.Alpaca.GetFloat64Response("camera", c.DeviceNumber, "pixelsizex") } /* - GetPixelSizeY() +GetPixelSizeY() - @returns the width of the CCD chip pixels in microns. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__pixelsizey +@returns the width of the CCD chip pixels in microns. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__pixelsizey */ func (c *Camera) GetPixelSizeY() (float64, error) { return c.Alpaca.GetFloat64Response("camera", c.DeviceNumber, "pixelsizey") } /* - GetReadOutMode() +GetReadOutMode() - @returns an index into the array ReadoutModes and returns the desired readout mode for the camera. Defaults to 0 if not set. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__readoutmode +@returns an index into the array ReadoutModes and returns the desired readout mode for the camera. Defaults to 0 if not set. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__readoutmode */ func (c *Camera) GetReadOutMode() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "readoutmode") } /* - SetReadOutMode() +SetReadOutMode() - @returns an error or nil, if nil sets the readout mode. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__readoutmode +@returns an error or nil, if nil sets the readout mode. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__readoutmode */ func (c *Camera) SetReadOutMode(readOutMode int32) error { c.Alpaca.TransactionId++ @@ -749,30 +749,30 @@ func (c *Camera) SetReadOutMode(readOutMode int32) error { } /* - GetReadOutModes() +GetReadOutModes() - @returns an array of strings, each of which describes an available readout mode of the camera. At least one string must be present in the list. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__readoutmodes +@returns an array of strings, each of which describes an available readout mode of the camera. At least one string must be present in the list. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__readoutmodes */ func (c *Camera) GetReadOutModes() ([]string, error) { return c.Alpaca.GetStringListResponse("camera", c.DeviceNumber, "readoutmodes") } /* - GetSensorName() +GetSensorName() - @returns the name of the sensor used within the camera. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__sensorname +@returns the name of the sensor used within the camera. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__sensorname */ func (c *Camera) GetSensorName() (string, error) { return c.Alpaca.GetStringResponse("camera", c.DeviceNumber, "sensorname") } /* - GetSensorType() +GetSensorType() - @returns the sensor type, e.g., whether the sensor is monochrome, or what Bayer matrix it encodes. Where: - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__sensortype +@returns the sensor type, e.g., whether the sensor is monochrome, or what Bayer matrix it encodes. Where: +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__sensortype */ func (c *Camera) GetSensorType() (SensorType, error) { sensor, err := c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "sensortype") @@ -780,20 +780,20 @@ func (c *Camera) GetSensorType() (SensorType, error) { } /* - GetCCDTemperatureCoolerSetPoint() +GetCCDTemperatureCoolerSetPoint() - @returns the current temperature setpoint of the CCD cooler in degrees Celsius. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__setccdtemperature +@returns the current temperature setpoint of the CCD cooler in degrees Celsius. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__setccdtemperature */ func (c *Camera) GetCCDTemperatureCoolerSetPoint() (float64, error) { return c.Alpaca.GetFloat64Response("camera", c.DeviceNumber, "setccdtemperature") } /* - SetCCDTemperatureCoolerSetPoint() +SetCCDTemperatureCoolerSetPoint() - @returns an error or nil, if nil it sets the camera's cooler setpoint in degrees Celsius. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__setccdtemperature +@returns an error or nil, if nil it sets the camera's cooler setpoint in degrees Celsius. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__setccdtemperature */ func (c *Camera) SetCCDTemperatureCoolerSetPoint(temperature float64) error { c.Alpaca.TransactionId++ @@ -808,20 +808,20 @@ func (c *Camera) SetCCDTemperatureCoolerSetPoint(temperature float64) error { } /* - GetStartX() +GetStartX() - @returns the current subframe start X coordinate, if binning is active, value is in binned pixels. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__startx +@returns the current subframe start X coordinate, if binning is active, value is in binned pixels. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__startx */ func (c *Camera) GetStartX() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "startx") } /* - SetStartX() +SetStartX() - @returns an error or nil, if nil sets the subframe start X coordinate, if binning is active, value is in binned pixels. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__startx +@returns an error or nil, if nil sets the subframe start X coordinate, if binning is active, value is in binned pixels. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__startx */ func (c *Camera) SetStartX(startX int32) error { c.Alpaca.TransactionId++ @@ -836,20 +836,20 @@ func (c *Camera) SetStartX(startX int32) error { } /* - GetStartY() +GetStartY() - @returns the current subframe start Y coordinate, if binning is active, value is in binned pixels. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__starty +@returns the current subframe start Y coordinate, if binning is active, value is in binned pixels. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__starty */ func (c *Camera) GetStartY() (int32, error) { return c.Alpaca.GetInt32Response("camera", c.DeviceNumber, "starty") } /* - SetStartY() +SetStartY() - @returns an error or nil, if nil sets the subframe start Y coordinate, if binning is active, value is in binned pixels. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__starty +@returns an error or nil, if nil sets the subframe start Y coordinate, if binning is active, value is in binned pixels. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__starty */ func (c *Camera) SetStartY(startY int32) error { c.Alpaca.TransactionId++ @@ -864,20 +864,20 @@ func (c *Camera) SetStartY(startY int32) error { } /* - GetSubExposureDuration() +GetSubExposureDuration() - @returns the sub exposure duration in seconds, *only available in Camera Interface Version 3 and later. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__subexposureduration +@returns the sub exposure duration in seconds, *only available in Camera Interface Version 3 and later. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/get_camera__device_number__subexposureduration */ func (c *Camera) GetSubExposureDuration() (float64, error) { return c.Alpaca.GetFloat64Response("camera", c.DeviceNumber, "subexposureduration") } /* - SetSubExposureDuration() +SetSubExposureDuration() - @returns an error or nil, if nil sets the sub exposure duration in seconds, *only available in Camera Interface Version 3 and later. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__subexposureduration +@returns an error or nil, if nil sets the sub exposure duration in seconds, *only available in Camera Interface Version 3 and later. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__subexposureduration */ func (c *Camera) SetSubExposureDuration(subExposureDuration float64) error { c.Alpaca.TransactionId++ @@ -892,10 +892,10 @@ func (c *Camera) SetSubExposureDuration(subExposureDuration float64) error { } /* - AbortExposure() +AbortExposure() - @returns an error or nil, if nil aborts the current exposure, if any, and returns the camera to Idle state. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__abortexposure +@returns an error or nil, if nil aborts the current exposure, if any, and returns the camera to Idle state. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__abortexposure */ func (c *Camera) AbortExposure() error { c.Alpaca.TransactionId++ @@ -909,10 +909,10 @@ func (c *Camera) AbortExposure() error { } /* - PulseGuide() +PulseGuide() - @returns an error or nil, if nil starts a pulse guide operation i.e., it activates the Camera's mount control sytem to instruct the mount to move in a particular direction for a given period of time - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__pulseguide +@returns an error or nil, if nil starts a pulse guide operation i.e., it activates the Camera's mount control sytem to instruct the mount to move in a particular direction for a given period of time +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__pulseguide */ func (c *Camera) SetPulseGuide(direction Direction, duration int32) error { c.Alpaca.TransactionId++ @@ -928,10 +928,10 @@ func (c *Camera) SetPulseGuide(direction Direction, duration int32) error { } /* - StartExposure() +StartExposure() - @returns an error or nil, if nil starts an exposure (use IsImageReady to check when the exposure is complete.) - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__startexposure +@returns an error or nil, if nil starts an exposure (use IsImageReady to check when the exposure is complete.) +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__startexposure */ func (c *Camera) StartExposure(duration float64, light bool) error { c.Alpaca.TransactionId++ @@ -947,10 +947,10 @@ func (c *Camera) StartExposure(duration float64, light bool) error { } /* - StopExposure() +StopExposure() - @returns an error or nil, if nil stops the current exposure, if any. If an exposure is in progress, the readout process is initiated. Ignored if readout is already in process. - @see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__stopexposure +@returns an error or nil, if nil stops the current exposure, if any. If an exposure is in progress, the readout process is initiated. Ignored if readout is already in process. +@see https://ascom-standards.org/api/#/Camera%20Specific%20Methods/put_camera__device_number__stopexposure */ func (c *Camera) StopExposure() error { c.Alpaca.TransactionId++ diff --git a/pkg/alpacago/conditions.go b/pkg/alpacago/conditions.go index ec5b4ee..d44e88b 100644 --- a/pkg/alpacago/conditions.go +++ b/pkg/alpacago/conditions.go @@ -19,21 +19,21 @@ func NewObservingConditions(clientId uint32, secure bool, domain string, ip stri } /* - IsConnected() common method to all ASCOM Alpaca compliant devices +IsConnected() common method to all ASCOM Alpaca compliant devices - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected */ func (c *ObservingConditions) IsConnected() (bool, error) { return c.Alpaca.GetBooleanResponse("observingconditions", c.DeviceNumber, "connected") } /* - SetConnected() common method to all ASCOM Alpaca compliant devices +SetConnected() common method to all ASCOM Alpaca compliant devices - @param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected +@param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected */ func (c *ObservingConditions) SetConnected(connected bool) error { c.Alpaca.TransactionId++ @@ -49,152 +49,152 @@ func (c *ObservingConditions) SetConnected(connected bool) error { } /* - GetAveragePeriod() +GetAveragePeriod() - @returns the time period over which observations will be averaged. - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__averageperiod +@returns the time period over which observations will be averaged. +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__averageperiod */ func (c *ObservingConditions) GetAveragePeriod() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "averageperiod") } /* - GetCloudCover() +GetCloudCover() - @returns the percentage of the sky obscured by cloud - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__cloudcover +@returns the percentage of the sky obscured by cloud +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__cloudcover */ func (c *ObservingConditions) GetCloudCover() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "cloudcover") } /* - GetDewPoint() +GetDewPoint() - @returns the atmospheric dew point at the observatory reported in °C. - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__dewpoint +@returns the atmospheric dew point at the observatory reported in °C. +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__dewpoint */ func (c *ObservingConditions) GetDewPoint() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "dewpoint") } /* - GetHumidity() +GetHumidity() - @returns the atmospheric humidity (%) at the observatory - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__humidity +@returns the atmospheric humidity (%) at the observatory +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__humidity */ func (c *ObservingConditions) GetHumidity() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "humidity") } /* - GetPressure() +GetPressure() - @returns the atmospheric pressure in hectoPascals at the observatory's altitude - NOT reduced to sea level. - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__pressure +@returns the atmospheric pressure in hectoPascals at the observatory's altitude - NOT reduced to sea level. +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__pressure */ func (c *ObservingConditions) GetPressure() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "pressure") } /* - GetRainRate() +GetRainRate() - @returns the rain rate (mm/hour) at the observatory. - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__rainrate +@returns the rain rate (mm/hour) at the observatory. +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__rainrate */ func (c *ObservingConditions) GetRainRate() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "rainrate") } /* - GetSkyBrightness() +GetSkyBrightness() - @returns the sky brightness (Lux) at the observatory - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__skybrightness +@returns the sky brightness (Lux) at the observatory +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__skybrightness */ func (c *ObservingConditions) GetSkyBrightness() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "skybrightness") } /* - GetSkyQuality() +GetSkyQuality() - @returns the sky quality (magnitudes per square arc second) at the observatory. - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__skyquality +@returns the sky quality (magnitudes per square arc second) at the observatory. +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__skyquality */ func (c *ObservingConditions) GetSkyQuality() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "skyquality") } /* - GetSkyTemperature() +GetSkyTemperature() - @returns the the sky temperature(°C) at the observatory. - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__skytemperature +@returns the the sky temperature(°C) at the observatory. +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__skytemperature */ func (c *ObservingConditions) GetSkyTemperature() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "skytemperature") } /* - GetSeeingStarFWHM() +GetSeeingStarFWHM() - @returns the seeing at the observatory measured as star full width half maximum (FWHM) in arc secs. - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__starfwhm +@returns the seeing at the observatory measured as star full width half maximum (FWHM) in arc secs. +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__starfwhm */ func (c *ObservingConditions) GetSeeingStarFWHM() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "starfwhm") } /* - GetTemperature() +GetTemperature() - @returns the temperature(°C) at the observatory. - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__temperature +@returns the temperature(°C) at the observatory. +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__temperature */ func (c *ObservingConditions) GetTemperature() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "temperature") } /* - GetWindDirection() +GetWindDirection() - @returns the the wind direction. The returned value must be between 0.0 and 360.0, interpreted according to the metereological standard, - where a special value of 0.0 is returned when the wind speed is 0.0. Wind direction is measured clockwise from north, through east, - where East=90.0, South=180.0, West=270.0 and North=360.0. - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__winddirection +@returns the the wind direction. The returned value must be between 0.0 and 360.0, interpreted according to the metereological standard, +where a special value of 0.0 is returned when the wind speed is 0.0. Wind direction is measured clockwise from north, through east, +where East=90.0, South=180.0, West=270.0 and North=360.0. +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__winddirection */ func (c *ObservingConditions) GetWindDirection() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "winddirection") } /* - GetWindGust() +GetWindGust() - @returns the peak 3 second wind gust(m/s) at the observatory over the last 2 minutes. - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__windgust +@returns the peak 3 second wind gust(m/s) at the observatory over the last 2 minutes. +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__windgust */ func (c *ObservingConditions) GetWindGust() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "windgust") } /* - GetWindSpeed() +GetWindSpeed() - @returns the wind speed(m/s) at the observatory. - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__windspeed +@returns the wind speed(m/s) at the observatory. +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__windspeed */ func (c *ObservingConditions) GetWindSpeed() (float64, error) { return c.Alpaca.GetFloat64Response("observingconditions", c.DeviceNumber, "windspeed") } /* - SetRefresh() +SetRefresh() - @returns an error or nil, if forces the driver to immediately query its attached hardware to refresh sensor values. - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/put_observingconditions__device_number__refresh +@returns an error or nil, if forces the driver to immediately query its attached hardware to refresh sensor values. +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/put_observingconditions__device_number__refresh */ func (c *ObservingConditions) SetRefresh() error { c.Alpaca.TransactionId++ @@ -208,10 +208,10 @@ func (c *ObservingConditions) SetRefresh() error { } /* - GetSensorDescription() +GetSensorDescription() - @returns a description of the sensor with the name specified in the SensorName parameter - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__sensordescription +@returns a description of the sensor with the name specified in the SensorName parameter +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__sensordescription */ func (c *ObservingConditions) GetSensorDescription(sensorName string) (string, error) { url := c.Alpaca.getEndpoint("observingconditions", c.DeviceNumber, "sensordescription") @@ -238,10 +238,10 @@ func (c *ObservingConditions) GetSensorDescription(sensorName string) (string, e } /* - GetTimeSinceLastUpdate() +GetTimeSinceLastUpdate() - @returns the time since the sensor specified in the SensorName parameter was last updated - @see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__timesincelastupdate +@returns the time since the sensor specified in the SensorName parameter was last updated +@see https://ascom-standards.org/api/#/ObservingConditions%20Specific%20Methods/get_observingconditions__device_number__timesincelastupdate */ func (c *ObservingConditions) GetTimeSinceLastUpdate(sensorName string) (float64, error) { url := c.Alpaca.getEndpoint("observingconditions", c.DeviceNumber, "timesincelastupdate") diff --git a/pkg/alpacago/discovery.go b/pkg/alpacago/discovery.go index c77fd42..be7dde0 100644 --- a/pkg/alpacago/discovery.go +++ b/pkg/alpacago/discovery.go @@ -61,10 +61,10 @@ func NewDiscoveryServer(clientId uint32, protocol string, domain string, ip stri } /* - OpenSocket() +OpenSocket() - @returns A bound open a socket for discovery on the udp4 network protocol, i.e., announce on the local network address. - @see https://ascom-standards.org/Developer/ASCOM%20Alpaca%20API%20Reference.pdf +@returns A bound open a socket for discovery on the udp4 network protocol, i.e., announce on the local network address. +@see https://ascom-standards.org/Developer/ASCOM%20Alpaca%20API%20Reference.pdf */ func (s *AlpacaDiscoveryServer) OpenSocket() { packet, err := net.ListenPacket("udp4", ":32227") @@ -79,10 +79,10 @@ func (s *AlpacaDiscoveryServer) OpenSocket() { } /* - ResolveUDPAddress() +ResolveUDPAddress() - @returns A resolved UDP address broadcast by the server. - @see https://ascom-standards.org/Developer/ASCOM%20Alpaca%20API%20Reference.pdf +@returns A resolved UDP address broadcast by the server. +@see https://ascom-standards.org/Developer/ASCOM%20Alpaca%20API%20Reference.pdf */ func (s *AlpacaDiscoveryServer) ResolveUDPAddress() { address, err := net.ResolveUDPAddr("udp4", ":32227") diff --git a/pkg/alpacago/dome.go b/pkg/alpacago/dome.go index 0748685..fa14bbc 100644 --- a/pkg/alpacago/dome.go +++ b/pkg/alpacago/dome.go @@ -45,21 +45,21 @@ func NewDome(clientId uint32, secure bool, domain string, ip string, port int32, } /* - IsConnected() common method to all ASCOM Alpaca compliant devices +IsConnected() common method to all ASCOM Alpaca compliant devices - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected */ func (d *Dome) IsConnected() (bool, error) { return d.Alpaca.GetBooleanResponse("dome", d.DeviceNumber, "connected") } /* - SetConnected() common method to all ASCOM Alpaca compliant devices +SetConnected() common method to all ASCOM Alpaca compliant devices - @param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected +@param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected */ func (d *Dome) SetConnected(connected bool) error { d.Alpaca.TransactionId++ @@ -75,133 +75,133 @@ func (d *Dome) SetConnected(connected bool) error { } /* - GetAltitude() +GetAltitude() - @returns The dome altitude (degrees, horizon zero and increasing positive to 90 zenith). - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__altitude +@returns The dome altitude (degrees, horizon zero and increasing positive to 90 zenith). +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__altitude */ func (d *Dome) GetAltitude() (float64, error) { return d.Alpaca.GetFloat64Response("dome", d.DeviceNumber, "altitude") } /* - IsAtHome() +IsAtHome() - @returns returns true if the dome is in the home position. This is normally used following a FindHome() operation. - The value is reset with any azimuth slew operation that moves the dome away from the home position. AtHome may - also become true durng normal slew operations, if the dome passes through the home position and the dome controller - hardware is capable of detecting that; or at the end of a slew operation if the dome comes to rest at the home position. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__athome +@returns returns true if the dome is in the home position. This is normally used following a FindHome() operation. +The value is reset with any azimuth slew operation that moves the dome away from the home position. AtHome may +also become true durng normal slew operations, if the dome passes through the home position and the dome controller +hardware is capable of detecting that; or at the end of a slew operation if the dome comes to rest at the home position. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__athome */ func (d *Dome) IsAtHome() (bool, error) { return d.Alpaca.GetBooleanResponse("dome", d.DeviceNumber, "athome") } /* - IsAtPark() +IsAtPark() - @returns true if the dome is in the programmed park position. Set only following a Park() operation and reset with any slew operation. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__atpark +@returns true if the dome is in the programmed park position. Set only following a Park() operation and reset with any slew operation. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__atpark */ func (d *Dome) IsAtPark() (bool, error) { return d.Alpaca.GetBooleanResponse("dome", d.DeviceNumber, "atpark") } /* - GetAzimuth() +GetAzimuth() - @returns the dome azimuth (degrees, North-referenced, positive East/clockwise, i.e., 90 East, 180 South, 270 West). - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__azimuth +@returns the dome azimuth (degrees, North-referenced, positive East/clockwise, i.e., 90 East, 180 South, 270 West). +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__azimuth */ func (d *Dome) GetAzimuth() (float64, error) { return d.Alpaca.GetFloat64Response("dome", d.DeviceNumber, "azimuth") } /* - CanFindHome() +CanFindHome() - @returns true if the dome can move to the home position. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__canfindhome +@returns true if the dome can move to the home position. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__canfindhome */ func (d *Dome) CanFindHome() (bool, error) { return d.Alpaca.GetBooleanResponse("dome", d.DeviceNumber, "canfindhome") } /* - CanPark() +CanPark() - @returns true if the dome is capable of programmed parking (Park() method) - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__canpark +@returns true if the dome is capable of programmed parking (Park() method) +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__canpark */ func (d *Dome) CanPark() (bool, error) { return d.Alpaca.GetBooleanResponse("dome", d.DeviceNumber, "canpark") } /* - CanSetAltitude() +CanSetAltitude() - @returns true if driver is capable of setting the dome altitude. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__cansetaltitude +@returns true if driver is capable of setting the dome altitude. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__cansetaltitude */ func (d *Dome) CanSetAltitude() (bool, error) { return d.Alpaca.GetBooleanResponse("dome", d.DeviceNumber, "cansetaltitude") } /* - CanSetAzimuth() +CanSetAzimuth() - @returns true if driver is capable of setting the dome azimuth. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__cansetazimuth +@returns true if driver is capable of setting the dome azimuth. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__cansetazimuth */ func (d *Dome) CanSetAzimuth() (bool, error) { return d.Alpaca.GetBooleanResponse("dome", d.DeviceNumber, "cansetazimuth") } /* - CanSetPark() +CanSetPark() - @returns true if driver is capable of setting the dome park position. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__cansetpark +@returns true if driver is capable of setting the dome park position. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__cansetpark */ func (d *Dome) CanSetPark() (bool, error) { return d.Alpaca.GetBooleanResponse("dome", d.DeviceNumber, "cansetpark") } /* - CanSetShutter() +CanSetShutter() - @returns true if driver is capable of setting the shutter state. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__cansetshutter +@returns true if driver is capable of setting the shutter state. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__cansetshutter */ func (d *Dome) CanSetShutter() (bool, error) { return d.Alpaca.GetBooleanResponse("dome", d.DeviceNumber, "cansetshutter") } /* - CanSlave() +CanSlave() - @returns true if driver is capable of slaving to a telescope. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__canslave +@returns true if driver is capable of slaving to a telescope. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__canslave */ func (d *Dome) CanSlave() (bool, error) { return d.Alpaca.GetBooleanResponse("dome", d.DeviceNumber, "canslave") } /* - CanSyncAzimuth() +CanSyncAzimuth() - @returns true if driver is capable of synchronizing the dome azimuth position using the SyncToAzimuth(Double) method. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__cansyncazimuth +@returns true if driver is capable of synchronizing the dome azimuth position using the SyncToAzimuth(Double) method. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__cansyncazimuth */ func (d *Dome) CanSyncAzimuth() (bool, error) { return d.Alpaca.GetBooleanResponse("dome", d.DeviceNumber, "cansyncazimuth") } /* - GetShutterStatus() +GetShutterStatus() - @returns the status of the dome shutter or roll-off roof. 0 = Open, 1 = Closed, 2 = Opening, 3 = Closing, 4 = Shutter status error - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__shutterstatus +@returns the status of the dome shutter or roll-off roof. 0 = Open, 1 = Closed, 2 = Opening, 3 = Closing, 4 = Shutter status error +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__shutterstatus */ func (d *Dome) GetShutterStatus() (ShutterStatus, error) { status, err := d.Alpaca.GetInt32Response("dome", d.DeviceNumber, "shutterstatus") @@ -209,20 +209,20 @@ func (d *Dome) GetShutterStatus() (ShutterStatus, error) { } /* - IsSlaved() +IsSlaved() - @returns true if the dome is slaved to the telescope in its hardware, else false. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__slaved +@returns true if the dome is slaved to the telescope in its hardware, else false. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__slaved */ func (d *Dome) IsSlaved() (bool, error) { return d.Alpaca.GetBooleanResponse("dome", d.DeviceNumber, "slaved") } /* - SetSlaved() +SetSlaved() - @returns error, or nil, if nil it sets the salved state of the dome. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__slaved +@returns error, or nil, if nil it sets the salved state of the dome. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__slaved */ func (d *Dome) SetSlaved(slaved bool) error { d.Alpaca.TransactionId++ @@ -238,20 +238,20 @@ func (d *Dome) SetSlaved(slaved bool) error { } /* - IsSlewing() +IsSlewing() - @return true if any part of the dome is currently moving, False if all dome components are steady. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__slewing +@return true if any part of the dome is currently moving, False if all dome components are steady. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/get_dome__device_number__slewing */ func (d *Dome) IsSlewing() (bool, error) { return d.Alpaca.GetBooleanResponse("dome", d.DeviceNumber, "slewing") } /* - AbortSlew() +AbortSlew() - @returs error, or nil, if nil it aborts the current slew operation. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__abortslew +@returs error, or nil, if nil it aborts the current slew operation. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__abortslew */ func (d *Dome) AbortSlew() error { d.Alpaca.TransactionId++ @@ -265,10 +265,10 @@ func (d *Dome) AbortSlew() error { } /* - CloseShutter() +CloseShutter() - @returns error, or nil, if nil it closes the shutter or otherwise shield telescope from the sky. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__closeshutter +@returns error, or nil, if nil it closes the shutter or otherwise shield telescope from the sky. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__closeshutter */ func (d *Dome) CloseShutter() error { d.Alpaca.TransactionId++ @@ -282,11 +282,11 @@ func (d *Dome) CloseShutter() error { } /* - FindHome() +FindHome() - @returns error, or nil, if nil it starts operation to search for the dome home position. - @effects after home position is established initializes azimuth to the default value and sets the AtHome flag. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__findhome +@returns error, or nil, if nil it starts operation to search for the dome home position. +@effects after home position is established initializes azimuth to the default value and sets the AtHome flag. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__findhome */ func (d *Dome) FindHome() error { d.Alpaca.TransactionId++ @@ -300,10 +300,10 @@ func (d *Dome) FindHome() error { } /* - OpenShutter() +OpenShutter() - @returns error, or nil, if nil it opens the shutter or otherwise expose telescope to the sky. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__openshutter +@returns error, or nil, if nil it opens the shutter or otherwise expose telescope to the sky. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__openshutter */ func (d *Dome) OpenShutter() error { d.Alpaca.TransactionId++ @@ -317,11 +317,11 @@ func (d *Dome) OpenShutter() error { } /* - Park() +Park() - @returns error, or nil, if nil it rotates the dome in azimuth to park position. - @effects After assuming programmed park position, sets AtPark flag. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__park +@returns error, or nil, if nil it rotates the dome in azimuth to park position. +@effects After assuming programmed park position, sets AtPark flag. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__park */ func (d *Dome) Park() error { d.Alpaca.TransactionId++ @@ -335,10 +335,10 @@ func (d *Dome) Park() error { } /* - SetAsPark() +SetAsPark() - @returns error, or nil, if nil it sets the current azimuth, altitude position of dome to be the park position. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__setpark +@returns error, or nil, if nil it sets the current azimuth, altitude position of dome to be the park position. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__setpark */ func (d *Dome) SetAsPark() error { d.Alpaca.TransactionId++ @@ -352,10 +352,10 @@ func (d *Dome) SetAsPark() error { } /* - SlewToAltitude() +SlewToAltitude() - @returns error, or nil, if nil it slews the dome to the specified altitude. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__slewtoaltitude +@returns error, or nil, if nil it slews the dome to the specified altitude. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__slewtoaltitude */ func (d *Dome) SlewToAltitude(altitude float64) error { d.Alpaca.TransactionId++ @@ -371,10 +371,10 @@ func (d *Dome) SlewToAltitude(altitude float64) error { } /* - SlewToAzimuth() +SlewToAzimuth() - @returns error, or nil, if nil it slews the dome to the given azimuth position. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__slewtoazimuth +@returns error, or nil, if nil it slews the dome to the given azimuth position. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__slewtoazimuth */ func (d *Dome) SlewToAzimuth(azimuth float64) error { d.Alpaca.TransactionId++ @@ -390,10 +390,10 @@ func (d *Dome) SlewToAzimuth(azimuth float64) error { } /* - SyncToAzimuth() +SyncToAzimuth() - @returns error, or nil, if nil it synchronizes the current position of the dome to the given azimuth. - @see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__synctoazimuth +@returns error, or nil, if nil it synchronizes the current position of the dome to the given azimuth. +@see https://ascom-standards.org/api/#/Dome%20Specific%20Methods/put_dome__device_number__synctoazimuth */ func (d *Dome) SyncToAzimuth(azimuth float64) error { d.Alpaca.TransactionId++ diff --git a/pkg/alpacago/filterwheel.go b/pkg/alpacago/filterwheel.go index cf0cc39..f46fb65 100644 --- a/pkg/alpacago/filterwheel.go +++ b/pkg/alpacago/filterwheel.go @@ -19,31 +19,31 @@ func NewFilterWheel(clientId uint32, secure bool, domain string, ip string, port } /* - GetDescription() common method to all ASCOM Alpaca compliant devices +GetDescription() common method to all ASCOM Alpaca compliant devices - @returns the description of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__description +@returns the description of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__description */ func (f *FilterWheel) GetDescription() (string, error) { return f.Alpaca.GetDescription("filterwheel", f.DeviceNumber) } /* - IsConnected() common method to all ASCOM Alpaca compliant devices +IsConnected() common method to all ASCOM Alpaca compliant devices - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected */ func (f *FilterWheel) IsConnected() (bool, error) { return f.Alpaca.GetBooleanResponse("filterwheel", f.DeviceNumber, "connected") } /* - SetConnected() common method to all ASCOM Alpaca compliant devices +SetConnected() common method to all ASCOM Alpaca compliant devices - @param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected +@param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected */ func (f *FilterWheel) SetConnected(connected bool) error { f.Alpaca.TransactionId++ @@ -59,40 +59,40 @@ func (f *FilterWheel) SetConnected(connected bool) error { } /* - GetFocusOffsets() +GetFocusOffsets() - @returns an integer array of filter focus offsets. - @see https://ascom-standards.org/api/#/FilterWheel%20Specific%20Methods/get_filterwheel__device_number__focusoffsets +@returns an integer array of filter focus offsets. +@see https://ascom-standards.org/api/#/FilterWheel%20Specific%20Methods/get_filterwheel__device_number__focusoffsets */ func (f *FilterWheel) GetFocusOffsets() ([]uint32, error) { return f.Alpaca.GetUInt32ListResponse("filterwheel", f.DeviceNumber, "focusoffsets") } /* - GetNames() +GetNames() - @returns the names of the filters. - @see https://ascom-standards.org/api/#/FilterWheel%20Specific%20Methods/get_filterwheel__device_number__names +@returns the names of the filters. +@see https://ascom-standards.org/api/#/FilterWheel%20Specific%20Methods/get_filterwheel__device_number__names */ func (f *FilterWheel) GetNames() ([]string, error) { return f.Alpaca.GetStringListResponse("filterwheel", f.DeviceNumber, "names") } /* - GetPosition() +GetPosition() - @returns the current filter wheel position. - @see https://ascom-standards.org/api/#/FilterWheel%20Specific%20Methods/get_filterwheel__device_number__position +@returns the current filter wheel position. +@see https://ascom-standards.org/api/#/FilterWheel%20Specific%20Methods/get_filterwheel__device_number__position */ func (f *FilterWheel) GetPosition() (int32, error) { return f.Alpaca.GetInt32Response("filterwheel", f.DeviceNumber, "position") } /* - SetPosition() +SetPosition() - @returns an error or nil, if nil it sets the filter wheel position - @see https://ascom-standards.org/api/#/FilterWheel%20Specific%20Methods/put_filterwheel__device_number__position +@returns an error or nil, if nil it sets the filter wheel position +@see https://ascom-standards.org/api/#/FilterWheel%20Specific%20Methods/put_filterwheel__device_number__position */ func (f *FilterWheel) SetPosition(position int32) error { f.Alpaca.TransactionId++ diff --git a/pkg/alpacago/focuser.go b/pkg/alpacago/focuser.go index add27a9..f74781f 100644 --- a/pkg/alpacago/focuser.go +++ b/pkg/alpacago/focuser.go @@ -19,31 +19,31 @@ func NewFocuser(clientId uint32, secure bool, domain string, ip string, port int } /* - GetDescription() common method to all ASCOM Alpaca compliant devices +GetDescription() common method to all ASCOM Alpaca compliant devices - @returns the description of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__description +@returns the description of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__description */ func (f *Focuser) GetDescription() (string, error) { return f.Alpaca.GetDescription("focuser", f.DeviceNumber) } /* - IsConnected() common method to all ASCOM Alpaca compliant devices +IsConnected() common method to all ASCOM Alpaca compliant devices - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected */ func (f *Focuser) IsConnected() (bool, error) { return f.Alpaca.GetBooleanResponse("focuser", f.DeviceNumber, "connected") } /* - SetConnected() common method to all ASCOM Alpaca compliant devices +SetConnected() common method to all ASCOM Alpaca compliant devices - @param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected +@param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected */ func (f *Focuser) SetConnected(connected bool) error { f.Alpaca.TransactionId++ @@ -59,81 +59,81 @@ func (f *Focuser) SetConnected(connected bool) error { } /* - IsAbsolute() +IsAbsolute() - @returns true if the focuser is capable of absolute position; that is, being commanded to a specific step location. - @see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__absolute +@returns true if the focuser is capable of absolute position; that is, being commanded to a specific step location. +@see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__absolute */ func (f *Focuser) IsAbsolute() (bool, error) { return f.Alpaca.GetBooleanResponse("focuser", f.DeviceNumber, "absolute") } /* - IsMoving() +IsMoving() - @returns true if the focuser is currently moving to a new position and false if the focuser is stationary. - @see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__ismoving +@returns true if the focuser is currently moving to a new position and false if the focuser is stationary. +@see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__ismoving */ func (f *Focuser) IsMoving() (bool, error) { return f.Alpaca.GetBooleanResponse("focuser", f.DeviceNumber, "ismoving") } /* - GetMaxIncrement() +GetMaxIncrement() - @returns the maximum increment size allowed by the focuser; i.e. the maximum number of steps allowed in one move operation. - @see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__maxincrement +@returns the maximum increment size allowed by the focuser; i.e. the maximum number of steps allowed in one move operation. +@see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__maxincrement */ func (f *Focuser) GetMaxIncrement() (int32, error) { return f.Alpaca.GetInt32Response("focuser", f.DeviceNumber, "maxincrement") } /* - GetMaxStep() +GetMaxStep() - @returns the maximum step size allowed by the focuser; i.e. the maximum step position permitted. - @see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__maxstep +@returns the maximum step size allowed by the focuser; i.e. the maximum step position permitted. +@see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__maxstep */ func (f *Focuser) GetMaxStep() (int32, error) { return f.Alpaca.GetInt32Response("focuser", f.DeviceNumber, "maxstep") } /* - GetPosition() +GetPosition() - @returns the focuser's current position. - @see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__position +@returns the focuser's current position. +@see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__position */ func (f *Focuser) GetPosition() (int32, error) { return f.Alpaca.GetInt32Response("focuser", f.DeviceNumber, "position") } /* - GetStepSize() +GetStepSize() - @returns the step size (microns) for the focuser. - @see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__stepsize +@returns the step size (microns) for the focuser. +@see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__stepsize */ func (f *Focuser) GetStepSize() (float64, error) { return f.Alpaca.GetFloat64Response("focuser", f.DeviceNumber, "stepsize") } /* - GetTemperatureCompensation() +GetTemperatureCompensation() - @returns the state of temperature compensation mode (if available), else always false. - @see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__tempcomp +@returns the state of temperature compensation mode (if available), else always false. +@see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__tempcomp */ func (f *Focuser) GetTemperatureCompensation() (bool, error) { return f.Alpaca.GetBooleanResponse("focuser", f.DeviceNumber, "tempcomp") } /* - SetTemperatureCompensation() +SetTemperatureCompensation() - @params tempComp bool (set true to enable the focuser's temperature compensation mode, otherwise false for normal operation.) - @returns an error or nil, if nil it sets the state of temperature compensation mode. - @see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/put_focuser__device_number__tempcomp +@params tempComp bool (set true to enable the focuser's temperature compensation mode, otherwise false for normal operation.) +@returns an error or nil, if nil it sets the state of temperature compensation mode. +@see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/put_focuser__device_number__tempcomp */ func (f *Focuser) SetTemperatureCompensation(tempComp bool) error { f.Alpaca.TransactionId++ @@ -149,30 +149,30 @@ func (f *Focuser) SetTemperatureCompensation(tempComp bool) error { } /* - IsTemperatureCompensationAvailable() +IsTemperatureCompensationAvailable() - @returns true if focuser has temperature compensation available., else always false. - @see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__tempcompavailable +@returns true if focuser has temperature compensation available., else always false. +@see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__tempcompavailable */ func (f *Focuser) IsTemperatureCompensationAvailable() (bool, error) { return f.Alpaca.GetBooleanResponse("focuser", f.DeviceNumber, "tempcompavailable") } /* - GetTemperature() +GetTemperature() - @returns the current ambient temperature as measured by the focuser. - @see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__temperature +@returns the current ambient temperature as measured by the focuser. +@see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/get_focuser__device_number__temperature */ func (f *Focuser) GetTemperature() (float64, error) { return f.Alpaca.GetFloat64Response("focuser", f.DeviceNumber, "temperature") } /* - SetHalt +SetHalt - @returns an error or nil, if nil it immediately stop any focuser motion due to a previous move() method call. - @see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/put_focuser__device_number__halt +@returns an error or nil, if nil it immediately stop any focuser motion due to a previous move() method call. +@see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/put_focuser__device_number__halt */ func (f *Focuser) SetHalt() error { f.Alpaca.TransactionId++ @@ -186,12 +186,12 @@ func (f *Focuser) SetHalt() error { } /* - SetMove +SetMove - @params position int32 (step distance or absolute position, depending on the value of the absolute property.) - @returns an error or nil, if nil it moves the focuser by the specified amount or to the specified - position depending on the value of the Absolute property. - @see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/put_focuser__device_number__move +@params position int32 (step distance or absolute position, depending on the value of the absolute property.) +@returns an error or nil, if nil it moves the focuser by the specified amount or to the specified +position depending on the value of the Absolute property. +@see https://ascom-standards.org/api/#/Focuser%20Specific%20Methods/put_focuser__device_number__move */ func (f *Focuser) SetMove(position int32) error { f.Alpaca.TransactionId++ diff --git a/pkg/alpacago/monitor.go b/pkg/alpacago/monitor.go index 57c889f..50e42e8 100644 --- a/pkg/alpacago/monitor.go +++ b/pkg/alpacago/monitor.go @@ -19,31 +19,31 @@ func NewSafetyMonitor(clientId uint32, secure bool, domain string, ip string, po } /* - GetDescription() common method to all ASCOM Alpaca compliant devices +GetDescription() common method to all ASCOM Alpaca compliant devices - @returns the description of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__description +@returns the description of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__description */ func (m *SafetyMonitor) GetDescription() (string, error) { return m.Alpaca.GetDescription("safetymonitor", m.DeviceNumber) } /* - IsConnected() common method to all ASCOM Alpaca compliant devices +IsConnected() common method to all ASCOM Alpaca compliant devices - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected */ func (m *SafetyMonitor) IsConnected() (bool, error) { return m.Alpaca.GetBooleanResponse("safetymonitor", m.DeviceNumber, "connected") } /* - SetConnected() common method to all ASCOM Alpaca compliant devices +SetConnected() common method to all ASCOM Alpaca compliant devices - @param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected +@param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected */ func (m *SafetyMonitor) SetConnected(connected bool) error { m.Alpaca.TransactionId++ @@ -59,10 +59,10 @@ func (m *SafetyMonitor) SetConnected(connected bool) error { } /* - IsSafe() +IsSafe() - @returns true if the state is safe, false if it is unsafe. Indicates whether the monitored state is safe for use. - @see https://ascom-standards.org/api/#/SafetyMonitor%20Specific%20Methods/get_safetymonitor__device_number__issafe +@returns true if the state is safe, false if it is unsafe. Indicates whether the monitored state is safe for use. +@see https://ascom-standards.org/api/#/SafetyMonitor%20Specific%20Methods/get_safetymonitor__device_number__issafe */ func (m *SafetyMonitor) IsSafe() (bool, error) { return m.Alpaca.GetBooleanResponse("safetymonitor", m.DeviceNumber, "issafe") diff --git a/pkg/alpacago/rotator.go b/pkg/alpacago/rotator.go index 9076d95..2f32bc9 100644 --- a/pkg/alpacago/rotator.go +++ b/pkg/alpacago/rotator.go @@ -19,31 +19,31 @@ func NewRotator(clientId uint32, secure bool, domain string, ip string, port int } /* - GetDescription() common method to all ASCOM Alpaca compliant devices +GetDescription() common method to all ASCOM Alpaca compliant devices - @returns the description of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__description +@returns the description of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__description */ func (r *Rotator) GetDescription() (string, error) { return r.Alpaca.GetDescription("rotator", r.DeviceNumber) } /* - IsConnected() common method to all ASCOM Alpaca compliant devices +IsConnected() common method to all ASCOM Alpaca compliant devices - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected */ func (r *Rotator) IsConnected() (bool, error) { return r.Alpaca.GetBooleanResponse("rotator", r.DeviceNumber, "connected") } /* - SetConnected() common method to all ASCOM Alpaca compliant devices +SetConnected() common method to all ASCOM Alpaca compliant devices - @param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected +@param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected */ func (r *Rotator) SetConnected(connected bool) error { r.Alpaca.TransactionId++ @@ -59,60 +59,60 @@ func (r *Rotator) SetConnected(connected bool) error { } /* - CanReverse() +CanReverse() - @returns true if the Rotator supports the Reverse method. - @see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__canreverse +@returns true if the Rotator supports the Reverse method. +@see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__canreverse */ func (r *Rotator) CanReverse() (bool, error) { return r.Alpaca.GetBooleanResponse("rotator", r.DeviceNumber, "canreverse") } /* - IsMoving() +IsMoving() - @returns true if the rotator is currently moving to a new position. False if the focuser is stationary. - @see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__ismoving +@returns true if the rotator is currently moving to a new position. False if the focuser is stationary. +@see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__ismoving */ func (r *Rotator) IsMoving() (bool, error) { return r.Alpaca.GetBooleanResponse("rotator", r.DeviceNumber, "ismoving") } /* - GetMechanicalPosition() +GetMechanicalPosition() - @returns the raw mechanical position of the rotator in degrees. - @see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__mechanicalposition +@returns the raw mechanical position of the rotator in degrees. +@see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__mechanicalposition */ func (r *Rotator) GetMechanicalPosition() (float64, error) { return r.Alpaca.GetFloat64Response("rotator", r.DeviceNumber, "mechanicalposition") } /* - GetPosition() +GetPosition() - @returns the current instantaneous Rotator position, in degrees. - @see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__position +@returns the current instantaneous Rotator position, in degrees. +@see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__position */ func (r *Rotator) GetPosition() (float64, error) { return r.Alpaca.GetFloat64Response("rotator", r.DeviceNumber, "mechanicalposition") } /* - GetReverse() +GetReverse() - @returns the rotator’s reverse state. - @see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__reverse +@returns the rotator’s reverse state. +@see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__reverse */ func (r *Rotator) GetReverse() (bool, error) { return r.Alpaca.GetBooleanResponse("rotator", r.DeviceNumber, "reverse") } /* - SetReverse +SetReverse - @returns an error or nil, if nil it sets the rotator’s reverse state. - @see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/put_rotator__device_number__reverse +@returns an error or nil, if nil it sets the rotator’s reverse state. +@see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/put_rotator__device_number__reverse */ func (r *Rotator) SetReverse(reverse bool) error { r.Alpaca.TransactionId++ @@ -127,30 +127,30 @@ func (r *Rotator) SetReverse(reverse bool) error { } /* - GetStepSize() +GetStepSize() - @returns the minimum step size, in degrees. - @see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__stepsize +@returns the minimum step size, in degrees. +@see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__stepsize */ func (r *Rotator) GetStepSize() (float64, error) { return r.Alpaca.GetFloat64Response("rotator", r.DeviceNumber, "stepsize") } /* - GetTargetPosition() +GetTargetPosition() - @returns the destination position angle for Move() and MoveAbsolute(). - @see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__stepsize +@returns the destination position angle for Move() and MoveAbsolute(). +@see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/get_rotator__device_number__stepsize */ func (r *Rotator) GetTargetPosition() (float64, error) { return r.Alpaca.GetFloat64Response("rotator", r.DeviceNumber, "stepsize") } /* - SetHalt() common method to all ASCOM Alpaca compliant devices +SetHalt() common method to all ASCOM Alpaca compliant devices - @returns an error or nil, if nil it immediately stop any Rotator motion due to a previous Move or MoveAbsolute method call. - @see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/put_rotator__device_number__halt +@returns an error or nil, if nil it immediately stop any Rotator motion due to a previous Move or MoveAbsolute method call. +@see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/put_rotator__device_number__halt */ func (r *Rotator) SetHalt() error { r.Alpaca.TransactionId++ @@ -164,11 +164,11 @@ func (r *Rotator) SetHalt() error { } /* - SetMove() +SetMove() - @params position float64 (relative position to move in degrees from current position.) - @returns an error or nil, if nil it causes the rotator to move position degrees relative to the current Position value. - @see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/put_rotator__device_number__move +@params position float64 (relative position to move in degrees from current position.) +@returns an error or nil, if nil it causes the rotator to move position degrees relative to the current Position value. +@see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/put_rotator__device_number__move */ func (r *Rotator) SetMove(position float64) error { r.Alpaca.TransactionId++ @@ -184,11 +184,11 @@ func (r *Rotator) SetMove(position float64) error { } /* - SetMoveAbsolute() +SetMoveAbsolute() - @params position float64 (absolute position in degrees.) - @returns an error or nil, if nil it causes the rotator to move the absolute position of Position degrees. - @see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/put_rotator__device_number__moveabsolute +@params position float64 (absolute position in degrees.) +@returns an error or nil, if nil it causes the rotator to move the absolute position of Position degrees. +@see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/put_rotator__device_number__moveabsolute */ func (r *Rotator) SetMoveAbsolute(position float64) error { r.Alpaca.TransactionId++ @@ -204,11 +204,11 @@ func (r *Rotator) SetMoveAbsolute(position float64) error { } /* - SetMoveMechanical() +SetMoveMechanical() - @params position float64 (absolute position in degrees.) - @returns an error or nil, if nil it causes the rotator to move the mechanical position of Position degrees. - @see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/put_rotator__device_number__movemechanical +@params position float64 (absolute position in degrees.) +@returns an error or nil, if nil it causes the rotator to move the mechanical position of Position degrees. +@see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/put_rotator__device_number__movemechanical */ func (r *Rotator) SetMoveMechanical(position float64) error { r.Alpaca.TransactionId++ @@ -224,11 +224,11 @@ func (r *Rotator) SetMoveMechanical(position float64) error { } /* - SetSync() +SetSync() - @params position float64 (absolute position in degrees.) - @returns an error or nil, if nil it causes the rotator to sync to the position of Position degrees. - @see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/put_rotator__device_number__sync +@params position float64 (absolute position in degrees.) +@returns an error or nil, if nil it causes the rotator to sync to the position of Position degrees. +@see https://ascom-standards.org/api/#/Rotator%20Specific%20Methods/put_rotator__device_number__sync */ func (r *Rotator) SetSync(position float64) error { r.Alpaca.TransactionId++ diff --git a/pkg/alpacago/telescope.go b/pkg/alpacago/telescope.go index db1311a..ccda29d 100644 --- a/pkg/alpacago/telescope.go +++ b/pkg/alpacago/telescope.go @@ -73,31 +73,31 @@ func NewTelescope(clientId uint32, secure bool, domain string, ip string, port i } /* - GetDescription() common method to all ASCOM Alpaca compliant devices +GetDescription() common method to all ASCOM Alpaca compliant devices - @returns the description of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__description +@returns the description of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__description */ func (t *Telescope) GetDescription() (string, error) { return t.Alpaca.GetDescription("telescope", t.DeviceNumber) } /* - IsConnected() common method to all ASCOM Alpaca compliant devices +IsConnected() common method to all ASCOM Alpaca compliant devices - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/get__device_type___device_number__connected */ func (t *Telescope) IsConnected() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "connected") } /* - SetConnected() common method to all ASCOM Alpaca compliant devices +SetConnected() common method to all ASCOM Alpaca compliant devices - @param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) - @returns the connected state of the device - @see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected +@param connected bool (set True to connect to the device hardware, set false to disconnect from the device hardware) +@returns the connected state of the device +@see https://ascom-standards.org/api/#/ASCOM%20Methods%20Common%20To%20All%20Devices/put__device_type___device_number__connected */ func (t *Telescope) SetConnected(connected bool) error { t.Alpaca.TransactionId++ @@ -113,10 +113,10 @@ func (t *Telescope) SetConnected(connected bool) error { } /* - SetAbortSlew() +SetAbortSlew() - @returns an error or nil, if nil immediately Stops a slew in progress. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__abortslew +@returns an error or nil, if nil immediately Stops a slew in progress. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__abortslew */ func (t *Telescope) SetAbortSlew() error { t.Alpaca.TransactionId++ @@ -130,12 +130,12 @@ func (t *Telescope) SetAbortSlew() error { } /* - GetAlignmentMode() +GetAlignmentMode() - @returns the alignment mode of the mount (Alt/Az, Polar, German Polar). - The alignment mode is specified as an integer value from the - AlignmentModes Enum. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__alignmentmode +@returns the alignment mode of the mount (Alt/Az, Polar, German Polar). +The alignment mode is specified as an integer value from the +AlignmentModes Enum. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__alignmentmode */ func (t *Telescope) GetAlignmentMode() (AlignmentMode, error) { mode, err := t.Alpaca.GetInt32Response("telescope", t.DeviceNumber, "alignmentmode") @@ -143,40 +143,40 @@ func (t *Telescope) GetAlignmentMode() (AlignmentMode, error) { } /* - GetAltitude() +GetAltitude() - @returns the altitude above the local horizon of the mount's current position (degrees, positive up) - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__altitude +@returns the altitude above the local horizon of the mount's current position (degrees, positive up) +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__altitude */ func (t *Telescope) GetAltitude() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "altitude") } /* - GetApertureArea() +GetApertureArea() - @returns the area of the telescope's aperture, taking into account any obstructions (square meters) - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__aperturearea +@returns the area of the telescope's aperture, taking into account any obstructions (square meters) +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__aperturearea */ func (t *Telescope) GetApertureArea() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "aperturearea") } /* - GetApertureDiameter() +GetApertureDiameter() - @returns the telescope's effective aperture diameter (meters) - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__aperturediameter +@returns the telescope's effective aperture diameter (meters) +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__aperturediameter */ func (t *Telescope) GetApertureDiameter() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "aperturearea") } /* - GetAxisRates() +GetAxisRates() - @returns the rates at which the telescope may be moved about the specified axis by the MoveAxis(TelescopeAxes, Double) method. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__axisrates +@returns the rates at which the telescope may be moved about the specified axis by the MoveAxis(TelescopeAxes, Double) method. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__axisrates */ func (t *Telescope) GetAxisRates(axis AxisType) (map[string]float64, error) { url := t.Alpaca.getEndpoint("telescope", t.DeviceNumber, "axisrates") @@ -198,50 +198,50 @@ func (t *Telescope) GetAxisRates(axis AxisType) (map[string]float64, error) { } /* - IsAtHome() +IsAtHome() - @returns true if the mount is stopped in the Home position. This property will alwayts be false if the telescope does not support homing. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__athome +@returns true if the mount is stopped in the Home position. This property will alwayts be false if the telescope does not support homing. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__athome */ func (t *Telescope) IsAtHome() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "athome") } /* - IsAtPark() +IsAtPark() - @returns true if the telescope has been put into the parked state by the seee Park() method. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__atpark +@returns true if the telescope has been put into the parked state by the seee Park() method. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__atpark */ func (t *Telescope) IsAtPark() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "atpark") } /* - GetAzimuth() +GetAzimuth() - @returns the azimuth at the local horizon of the mount's current position (degrees, North-referenced, positive East/clockwise). - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__azimuth +@returns the azimuth at the local horizon of the mount's current position (degrees, North-referenced, positive East/clockwise). +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__azimuth */ func (t *Telescope) GetAzimuth() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "azimuth") } /* - CanFindHome() +CanFindHome() - @returns true if this telescope is capable of programmed finding its home position (FindHome() method). - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canfindhome +@returns true if this telescope is capable of programmed finding its home position (FindHome() method). +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canfindhome */ func (t *Telescope) CanFindHome() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "canfindhome") } /* - CanMoveAxis() +CanMoveAxis() - @returns true if this telescope can move the requested axis. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canmoveaxis +@returns true if this telescope can move the requested axis. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canmoveaxis */ func (t *Telescope) CanMoveAxis(axis AxisType) (bool, error) { url := t.Alpaca.getEndpoint("telescope", t.DeviceNumber, "canmoveaxis") @@ -268,160 +268,160 @@ func (t *Telescope) CanMoveAxis(axis AxisType) (bool, error) { } /* - CanPark() +CanPark() - @returns true if this telescope is capable of programmed parking (Park() method) - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canpark +@returns true if this telescope is capable of programmed parking (Park() method) +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canpark */ func (t *Telescope) CanPark() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "canpark") } /* - CanPulseGuide() +CanPulseGuide() - @returns true if this telescope is capable of software-pulsed guiding (via the PulseGuide(GuideDirections, Int32) method) - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canpulseguide +@returns true if this telescope is capable of software-pulsed guiding (via the PulseGuide(GuideDirections, Int32) method) +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canpulseguide */ func (t *Telescope) CanPulseGuide() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "canpulseguide") } /* - CanSetDeclinationRate() +CanSetDeclinationRate() - @returns true if the DeclinationRate property can be changed to provide offset tracking in the declination axis. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansetdeclinationrate +@returns true if the DeclinationRate property can be changed to provide offset tracking in the declination axis. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansetdeclinationrate */ func (t *Telescope) CanSetDeclinationRate() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "cansetdeclinationrate") } /* - CanSetGuideRates() +CanSetGuideRates() - @returns true if the guide rate properties used for PulseGuide(GuideDirections, Int32) can ba adjusted. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansetguiderates +@returns true if the guide rate properties used for PulseGuide(GuideDirections, Int32) can ba adjusted. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansetguiderates */ func (t *Telescope) CanSetGuideRates() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "cansetguiderates") } /* - CanSetPark() +CanSetPark() - @returns true if this telescope is capable of programmed parking (Park() method) - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansetpark +@returns true if this telescope is capable of programmed parking (Park() method) +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansetpark */ func (t *Telescope) CanSetPark() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "cansetpark") } /* - CanSetPierSide() +CanSetPierSide() - @returns true if the SideOfPier property can be set, meaning that the mount can be forced to flip. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansetpierside +@returns true if the SideOfPier property can be set, meaning that the mount can be forced to flip. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansetpierside */ func (t *Telescope) CanSetPierSide() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "cansetpierside") } /* - CanSetRightAscensionRate() +CanSetRightAscensionRate() - @returns true if the RightAscensionRate property can be changed to provide offset tracking in the right ascension axis. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansetrightascensionrate +@returns true if the RightAscensionRate property can be changed to provide offset tracking in the right ascension axis. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansetrightascensionrate */ func (t *Telescope) CanSetRightAscensionRate() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "cansetrightascensionrate") } /* - CanSetTracking() +CanSetTracking() - @returns true if the Tracking property can be changed, turning telescope sidereal tracking on and off. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansettracking +@returns true if the Tracking property can be changed, turning telescope sidereal tracking on and off. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansettracking */ func (t *Telescope) CanSetTracking() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "cansettracking") } /* - CanSlew() +CanSlew() - @returns true if this telescope is capable of programmed slewing (synchronous or asynchronous) to equatorial coordinates - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canslew +@returns true if this telescope is capable of programmed slewing (synchronous or asynchronous) to equatorial coordinates +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canslew */ func (t *Telescope) CanSlew() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "canslew") } /* - CanSlewAltAz() +CanSlewAltAz() - @returns true if this telescope is capable of programmed slewing (synchronous or asynchronous) to local horizontal coordinates - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canslewaltaz +@returns true if this telescope is capable of programmed slewing (synchronous or asynchronous) to local horizontal coordinates +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canslewaltaz */ func (t *Telescope) CanSlewAltAz() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "canslewaltaz") } /* - CanSlewAltAzAsync() +CanSlewAltAzAsync() - @returns true if this telescope is capable of programmed asynchronous slewing to local horizontal coordinates - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canslewaltazasync +@returns true if this telescope is capable of programmed asynchronous slewing to local horizontal coordinates +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canslewaltazasync */ func (t *Telescope) CanSlewAltAzAsync() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "canslewaltazasync") } /* - CanSlewAsync() +CanSlewAsync() - @returns true if this telescope is capable of programmed asynchronous slewing to equatorial coordinates - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canslewasync +@returns true if this telescope is capable of programmed asynchronous slewing to equatorial coordinates +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canslewasync */ func (t *Telescope) CanSlewAsync() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "canslewasync") } /* - CanSync() +CanSync() - @returns true if this telescope is capable of programmed synching to equatorial coordinates - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansync +@returns true if this telescope is capable of programmed synching to equatorial coordinates +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansync */ func (t *Telescope) CanSync() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "cansync") } /* - CanSyncAltAz() +CanSyncAltAz() - @returns true if this telescope is capable of programmed synching to local horizontal coordinates - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansyncaltaz +@returns true if this telescope is capable of programmed synching to local horizontal coordinates +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__cansyncaltaz */ func (t *Telescope) CanSyncAltAz() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "cansyncaltaz") } /* - CanUnPark() +CanUnPark() - @returns true if this telescope is capable of programmed unparking (UnPark() method) - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canunpark +@returns true if this telescope is capable of programmed unparking (UnPark() method) +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__canunpark */ func (t *Telescope) CanUnPark() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "canunpark") } /* - SetUnPark() +SetUnPark() - @returns an error or nil, if nil it takes telescope out of the Parked state. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__unpark +@returns an error or nil, if nil it takes telescope out of the Parked state. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__unpark */ func (t *Telescope) SetUnPark() error { t.Alpaca.TransactionId++ @@ -435,32 +435,32 @@ func (t *Telescope) SetUnPark() error { } /* - GetDeclination() +GetDeclination() - @returns the declination (degrees) of the mount's current equatorial coordinates, in the coordinate - system given by the EquatorialSystem property. Reading the property will raise an error if the value - is unavailable. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__declination +@returns the declination (degrees) of the mount's current equatorial coordinates, in the coordinate +system given by the EquatorialSystem property. Reading the property will raise an error if the value +is unavailable. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__declination */ func (t *Telescope) GetDeclination() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "declination") } /* - GetDeclinationRate() +GetDeclinationRate() - @returns the declination tracking rate (arcseconds per second, default = 0.0) - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__declinationrate +@returns the declination tracking rate (arcseconds per second, default = 0.0) +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__declinationrate */ func (t *Telescope) GetDeclinationRate() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "declinationrate") } /* - SetDeclinationRate() +SetDeclinationRate() - @returns an error or nil, if nil it sets the declination tracking rate (arcseconds per second) - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__declinationrate +@returns an error or nil, if nil it sets the declination tracking rate (arcseconds per second) +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__declinationrate */ func (t *Telescope) SetDeclinationRate(declinationRate float64) error { t.Alpaca.TransactionId++ @@ -475,22 +475,22 @@ func (t *Telescope) SetDeclinationRate(declinationRate float64) error { } /* - DoesRefraction() +DoesRefraction() - @returns true if the telescope or driver applies atmospheric refraction to coordinates - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__doesrefraction +@returns true if the telescope or driver applies atmospheric refraction to coordinates +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__doesrefraction */ func (t *Telescope) DoesRefraction() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "doesrefraction") } /* - SetDoesRefraction() +SetDoesRefraction() - Determines whether atmospheric refraction is applied to coordinates. +Determines whether atmospheric refraction is applied to coordinates. - @returns an error or nil, if nil causes the rotator to move Position degrees relative to the current position value. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__doesrefraction +@returns an error or nil, if nil causes the rotator to move Position degrees relative to the current position value. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__doesrefraction */ func (t *Telescope) SetDoesRefraction(doesRefraction bool) error { t.Alpaca.TransactionId++ @@ -505,10 +505,10 @@ func (t *Telescope) SetDoesRefraction(doesRefraction bool) error { } /* - GetEquatorialSystem() +GetEquatorialSystem() - @returns the current equatorial coordinate system used by this telescope (e.g. Topocentric or J2000). - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__equatorialsystem +@returns the current equatorial coordinate system used by this telescope (e.g. Topocentric or J2000). +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__equatorialsystem */ func (t *Telescope) GetEquatorialSystem() (EquatorialSystem, error) { system, err := t.Alpaca.GetInt32Response("telescope", t.DeviceNumber, "equatorialsystem") @@ -516,51 +516,51 @@ func (t *Telescope) GetEquatorialSystem() (EquatorialSystem, error) { } /* - GetFocalLength() +GetFocalLength() - @returns the telescope's focal length in meters - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__focallength +@returns the telescope's focal length in meters +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__focallength */ func (t *Telescope) GetFocalLength() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "focallength") } /* - IsPulseGuiding() +IsPulseGuiding() - @returns true if a PulseGuide(GuideDirections, Int32) command is in progress, false otherwise - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__ispulseguiding +@returns true if a PulseGuide(GuideDirections, Int32) command is in progress, false otherwise +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__ispulseguiding */ func (t *Telescope) IsPulseGuiding() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "ispulseguiding") } /* - GetRightAscension() +GetRightAscension() - @returns the right ascension (hours) of the mount's current equatorial coordinates, in the coordinate - system given by the EquatorialSystem property - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__rightascension +@returns the right ascension (hours) of the mount's current equatorial coordinates, in the coordinate +system given by the EquatorialSystem property +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__rightascension */ func (t *Telescope) GetRightAscension() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "rightascension") } /* - GetRightAscensionRate() +GetRightAscensionRate() - @returns the right ascension tracking rate (arcseconds per second, default = 0.0) - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__rightascensionrate +@returns the right ascension tracking rate (arcseconds per second, default = 0.0) +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__rightascensionrate */ func (t *Telescope) GetRightAscensionRate() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "rightascensionrate") } /* - SetRightAscensionRate() +SetRightAscensionRate() - @returns an error or nil, if nil it sets the right ascension tracking rate (arcseconds per second) - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__rightascensionrate +@returns an error or nil, if nil it sets the right ascension tracking rate (arcseconds per second) +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__rightascensionrate */ func (t *Telescope) SetRightAscensionRate(rightAscensionRate float64) error { t.Alpaca.TransactionId++ @@ -575,10 +575,10 @@ func (t *Telescope) SetRightAscensionRate(rightAscensionRate float64) error { } /* - GetSideOfPier() +GetSideOfPier() - @returns the pointing state of the mount. 0 = pierEast, 1 = pierWest, -1= pierUnknown - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__sideofpier +@returns the pointing state of the mount. 0 = pierEast, 1 = pierWest, -1= pierUnknown +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__sideofpier */ func (t *Telescope) GetSideOfPier() (PierPointingMode, error) { mode, err := t.Alpaca.GetInt32Response("telescope", t.DeviceNumber, "sideofpier") @@ -586,10 +586,10 @@ func (t *Telescope) GetSideOfPier() (PierPointingMode, error) { } /* - SetSideOfPier() +SetSideOfPier() - @returns an error or nil, if nil it sets the pointing state of the mount. 0 = pierEast, 1 = pierWest - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__sideofpier +@returns an error or nil, if nil it sets the pointing state of the mount. 0 = pierEast, 1 = pierWest +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__sideofpier */ func (t *Telescope) SetSideOfPier(sideOfPier PierPointingMode) error { t.Alpaca.TransactionId++ @@ -608,31 +608,31 @@ func (t *Telescope) SetSideOfPier(sideOfPier PierPointingMode) error { } /* - GetSiderealTime() +GetSiderealTime() - @returns the local apparent sidereal time from the telescope's internal clock (hours, sidereal). - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__siderealtime +@returns the local apparent sidereal time from the telescope's internal clock (hours, sidereal). +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__siderealtime */ func (t *Telescope) GetSiderealTime() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "siderealtime") } /* - GetSiteElevation() +GetSiteElevation() - @returns the elevation above mean sea level (meters) of the site at which the telescope is located. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__siteelevation +@returns the elevation above mean sea level (meters) of the site at which the telescope is located. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__siteelevation */ func (t *Telescope) GetSiteElevation() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "siteelevation") } /* - SetSiteElevation() +SetSiteElevation() - @params siteElevation - the site elevation above mean sea level (metres). - @returns an error or nil, if nil it sets the elevation above mean sea level (metres) of the site at which the telescope is located. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__siteelevation +@params siteElevation - the site elevation above mean sea level (metres). +@returns an error or nil, if nil it sets the elevation above mean sea level (metres) of the site at which the telescope is located. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__siteelevation */ func (t *Telescope) SetSiteElevation(siteElevation float64) error { t.Alpaca.TransactionId++ @@ -651,20 +651,20 @@ func (t *Telescope) SetSiteElevation(siteElevation float64) error { } /* - GetSiteLatitude() +GetSiteLatitude() - @returns the geodetic(map) latitude (degrees, positive North, WGS84) of the site at which the telescope is located. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__sitelatitude +@returns the geodetic(map) latitude (degrees, positive North, WGS84) of the site at which the telescope is located. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__sitelatitude */ func (t *Telescope) GetSiteLatitude() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "sitelatitude") } /* - SetSiteLatitude() +SetSiteLatitude() - @returns an error or nil, if nil it sets the observing site's latitude (degrees). - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__sitelatitude +@returns an error or nil, if nil it sets the observing site's latitude (degrees). +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__sitelatitude */ func (t *Telescope) SetSiteLatitude(siteLatitude float64) error { t.Alpaca.TransactionId++ @@ -683,20 +683,20 @@ func (t *Telescope) SetSiteLatitude(siteLatitude float64) error { } /* - GetSiteLongitude() +GetSiteLongitude() - @returns the geodetic(map) longitude (degrees, positive East, WGS84) of the site at which the telescope is located. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__sitelongitude +@returns the geodetic(map) longitude (degrees, positive East, WGS84) of the site at which the telescope is located. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__sitelongitude */ func (t *Telescope) GetSiteLongitude() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "sitelongitude") } /* - SetSiteLongitude() +SetSiteLongitude() - @returns an error or nil, if nil it sets the observing site's longitude (degrees, positive East, WGS84). - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__sitelongitude +@returns an error or nil, if nil it sets the observing site's longitude (degrees, positive East, WGS84). +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__sitelongitude */ func (t *Telescope) SetSiteLongitude(siteLongitude float64) error { t.Alpaca.TransactionId++ @@ -715,31 +715,31 @@ func (t *Telescope) SetSiteLongitude(siteLongitude float64) error { } /* - IsSlewing() +IsSlewing() - @returns true if telescope is currently moving in response to one of the Slew methods or the MoveAxis(TelescopeAxes, - Double) method, false at all other times. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__slewing +@returns true if telescope is currently moving in response to one of the Slew methods or the MoveAxis(TelescopeAxes, +Double) method, false at all other times. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__slewing */ func (t *Telescope) IsSlewing() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "slewing") } /* - GetSlewSettleTime() +GetSlewSettleTime() - @returns the post-slew settling time (in seconds). - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__slewsettletime +@returns the post-slew settling time (in seconds). +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__slewsettletime */ func (t *Telescope) GetSlewSettleTime() (int32, error) { return t.Alpaca.GetInt32Response("telescope", t.DeviceNumber, "slewsettletime") } /* - SetSlewSettleTime() +SetSlewSettleTime() - @returns an error or nil, if nil it sets the post-slew settling time (integer sec.). - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewsettletime +@returns an error or nil, if nil it sets the post-slew settling time (integer sec.). +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewsettletime */ func (t *Telescope) SetSlewSettleTime(slewSettleTime int32) error { t.Alpaca.TransactionId++ @@ -754,10 +754,10 @@ func (t *Telescope) SetSlewSettleTime(slewSettleTime int32) error { } /* - SetSlewToAltAz +SetSlewToAltAz - @returns an error or nil, if nil it moves the telescope to the given local horizontal coordinates, return when slew is complete - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewtoaltaz +@returns an error or nil, if nil it moves the telescope to the given local horizontal coordinates, return when slew is complete +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewtoaltaz */ func (t *Telescope) SetSlewToAltAz(altitude float64, azimuth float64) error { t.Alpaca.TransactionId++ @@ -783,11 +783,11 @@ func (t *Telescope) SetSlewToAltAz(altitude float64, azimuth float64) error { } /* - SetSlewToAltAzAsync +SetSlewToAltAzAsync - @returns an error or nil, if nil it moves the telescope to the given local horizontal coordinates, return immediatley after - the slew starts. The client can poll the Slewing method to determine when the mount reaches the intended coordinates. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewtoaltazasync +@returns an error or nil, if nil it moves the telescope to the given local horizontal coordinates, return immediatley after +the slew starts. The client can poll the Slewing method to determine when the mount reaches the intended coordinates. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewtoaltazasync */ func (t *Telescope) SetSlewToAltAzAsync(altitude float64, azimuth float64) error { t.Alpaca.TransactionId++ @@ -813,11 +813,11 @@ func (t *Telescope) SetSlewToAltAzAsync(altitude float64, azimuth float64) error } /* - SetSlewToCoordinates +SetSlewToCoordinates - @returns an error or nil, if nil it moves the telescope to the given local horizontal coordinates, return immediatley after - the slew starts. The client can poll the Slewing method to determine when the mount reaches the intended coordinates. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewtocoordinates +@returns an error or nil, if nil it moves the telescope to the given local horizontal coordinates, return immediatley after +the slew starts. The client can poll the Slewing method to determine when the mount reaches the intended coordinates. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewtocoordinates */ func (t *Telescope) SetSlewToCoordinates(rightAscension float64, declination float64) error { t.Alpaca.TransactionId++ @@ -845,11 +845,11 @@ func (t *Telescope) SetSlewToCoordinates(rightAscension float64, declination flo } /* - SetSlewToCoordinatesAsync +SetSlewToCoordinatesAsync - @returns an error or nil, if nil it moves the telescope to the given equatorial coordinates, return immediatley after - the slew starts. The client can poll the Slewing method to determine when the mount reaches the intended coordinates. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewtocoordinatesasync +@returns an error or nil, if nil it moves the telescope to the given equatorial coordinates, return immediatley after +the slew starts. The client can poll the Slewing method to determine when the mount reaches the intended coordinates. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewtocoordinatesasync */ func (t *Telescope) SetSlewToCoordinatesAsync(rightAscension float64, declination float64) error { t.Alpaca.TransactionId++ @@ -877,11 +877,11 @@ func (t *Telescope) SetSlewToCoordinatesAsync(rightAscension float64, declinatio } /* - SetSlewToTarget +SetSlewToTarget - @returns an error or nil, if nil it moves the telescope to the TargetRightAscension and TargetDeclination - equatorial coordinates, return when slew is complete - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewtotarget +@returns an error or nil, if nil it moves the telescope to the TargetRightAscension and TargetDeclination +equatorial coordinates, return when slew is complete +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewtotarget */ func (t *Telescope) SetSlewToTarget() error { t.Alpaca.TransactionId++ @@ -897,12 +897,12 @@ func (t *Telescope) SetSlewToTarget() error { } /* - SetSlewToTargetAsync +SetSlewToTargetAsync - @returns an error or nil, if nil it moves the telescope to the TargetRightAscension and TargetDeclination equatorial coordinates, - return immediatley after the slew starts. The client can poll the Slewing method to determine when the mount reaches the - intended coordinates. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewtotargetasync +@returns an error or nil, if nil it moves the telescope to the TargetRightAscension and TargetDeclination equatorial coordinates, +return immediatley after the slew starts. The client can poll the Slewing method to determine when the mount reaches the +intended coordinates. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__slewtotargetasync */ func (t *Telescope) SetSlewToTargetAsync() error { t.Alpaca.TransactionId++ @@ -918,20 +918,20 @@ func (t *Telescope) SetSlewToTargetAsync() error { } /* - GetTargetDeclination() +GetTargetDeclination() - @returns the declination (degrees, positive North) for the target of an equatorial slew or sync operation. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__targetdeclination +@returns the declination (degrees, positive North) for the target of an equatorial slew or sync operation. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__targetdeclination */ func (t *Telescope) GetTargetDeclination() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "targetdeclination") } /* - SetTargetDeclination() +SetTargetDeclination() - @returns an error or nil, if nil it sets the declination (degrees, positive North) for the target of an equatorial slew or sync operation. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__targetdeclination +@returns an error or nil, if nil it sets the declination (degrees, positive North) for the target of an equatorial slew or sync operation. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__targetdeclination */ func (t *Telescope) SetTargetDeclination(targetDeclination float64) error { t.Alpaca.TransactionId++ @@ -946,20 +946,20 @@ func (t *Telescope) SetTargetDeclination(targetDeclination float64) error { } /* - GetTargetRightAscension() +GetTargetRightAscension() - @returns the right ascension (hours) for the target of an equatorial slew or sync operation - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__targetrightascension +@returns the right ascension (hours) for the target of an equatorial slew or sync operation +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__targetrightascension */ func (t *Telescope) GetTargetRightAscension() (float64, error) { return t.Alpaca.GetFloat64Response("telescope", t.DeviceNumber, "targetrightascension") } /* - SetTargetRightAscension() +SetTargetRightAscension() - @returns an error or nil, if nil it the right ascension (hours) for the target of an equatorial slew or sync operation - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__targetrightascension +@returns an error or nil, if nil it the right ascension (hours) for the target of an equatorial slew or sync operation +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__targetrightascension */ func (t *Telescope) SetTargetRightAscension(targetRightAscension float64) error { t.Alpaca.TransactionId++ @@ -974,20 +974,20 @@ func (t *Telescope) SetTargetRightAscension(targetRightAscension float64) error } /* - IsTracking() +IsTracking() - @returns the state of the telescope's sidereal tracking drive. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__tracking +@returns the state of the telescope's sidereal tracking drive. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__tracking */ func (t *Telescope) IsTracking() (bool, error) { return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "tracking") } /* - SetTracking() +SetTracking() - @returns an error or nil, if nil it sets the state of the telescope's sidereal tracking drive. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__tracking +@returns an error or nil, if nil it sets the state of the telescope's sidereal tracking drive. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__tracking */ func (t *Telescope) SetTracking(tracking bool) error { t.Alpaca.TransactionId++ @@ -1002,23 +1002,23 @@ func (t *Telescope) SetTracking(tracking bool) error { } /* - GetTrackingRate() +GetTrackingRate() - @returns the current tracking rate of the telescope's sidereal drive. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__trackingrate +@returns the current tracking rate of the telescope's sidereal drive. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__trackingrate */ func (t *Telescope) GetTrackingRate() (int32, error) { return t.Alpaca.GetInt32Response("telescope", t.DeviceNumber, "trackingrate") } /* - GetUTCDate() +GetUTCDate() - @returns the UTC date/time of the telescope's internal clock in ISO 8601 format including fractional - seconds. The general format (in Microsoft custom date format style) is yyyy-MM-ddTHH:mm:ss.fffffffZ - e.g. 2016-03-04T17:45:31.1234567Z or 2016-11-14T07:03:08.1234567Z Please note the compulsary trailing - Z indicating the 'Zulu', UTC time zone. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__utcdate +@returns the UTC date/time of the telescope's internal clock in ISO 8601 format including fractional +seconds. The general format (in Microsoft custom date format style) is yyyy-MM-ddTHH:mm:ss.fffffffZ +e.g. 2016-03-04T17:45:31.1234567Z or 2016-11-14T07:03:08.1234567Z Please note the compulsary trailing +Z indicating the 'Zulu', UTC time zone. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/get_telescope__device_number__utcdate */ func (t *Telescope) GetUTCDate() (time.Time, error) { utc, err := t.Alpaca.GetStringResponse("telescope", t.DeviceNumber, "utcdate") @@ -1027,13 +1027,13 @@ func (t *Telescope) GetUTCDate() (time.Time, error) { } /* - SetUTCDate() +SetUTCDate() - @returns an error or nil, if nil it sets the UTC date/time of the telescope's internal clock in ISO 8601 format including fractional - seconds. The general format (in Microsoft custom date format style) is yyyy-MM-ddTHH:mm:ss.fffffffZ - e.g. 2016-03-04T17:45:31.1234567Z or 2016-11-14T07:03:08.1234567Z Please note the compulsary trailing - Z indicating the 'Zulu', UTC time zone. - @see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__utcdate +@returns an error or nil, if nil it sets the UTC date/time of the telescope's internal clock in ISO 8601 format including fractional +seconds. The general format (in Microsoft custom date format style) is yyyy-MM-ddTHH:mm:ss.fffffffZ +e.g. 2016-03-04T17:45:31.1234567Z or 2016-11-14T07:03:08.1234567Z Please note the compulsary trailing +Z indicating the 'Zulu', UTC time zone. +@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__utcdate */ func (t *Telescope) SetUTCDate(UTCDate time.Time) error { t.Alpaca.TransactionId++