Merge pull request #284 from observerly/feature/telescope/FindHome

feat: Added (t *Telescope) FindHome() to alpaca module.

coverage.txt

@@ -5,7 +5,7 @@ github.com/observerly/alpacago/pkg/alpacago/alpaca.go:37.2,39.35 2 52
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:39.35,41.3 1 10
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:43.2,50.16 2 52
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:60.56,62.2 1 214
-github.com/observerly/alpacago/pkg/alpacago/alpaca.go:71.104,73.2 1 407
+github.com/observerly/alpacago/pkg/alpacago/alpaca.go:71.104,73.2 1 408
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:88.119,95.16 3 13
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:95.16,97.3 1 0
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:100.2,100.20 1 13
@@ -41,13 +41,13 @@ github.com/observerly/alpacago/pkg/alpacago/alpaca.go:306.16,308.3 1 0
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:311.2,311.20 1 2
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:311.20,314.3 2 0
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:317.2,319.39 2 2
-github.com/observerly/alpacago/pkg/alpacago/alpaca.go:329.119,335.16 3 193
+github.com/observerly/alpacago/pkg/alpacago/alpaca.go:329.119,335.16 3 194
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:335.16,337.3 1 0
-github.com/observerly/alpacago/pkg/alpacago/alpaca.go:340.2,340.20 1 193
+github.com/observerly/alpacago/pkg/alpacago/alpaca.go:340.2,340.20 1 194
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:340.20,343.3 2 1
-github.com/observerly/alpacago/pkg/alpacago/alpaca.go:346.2,348.29 2 193
+github.com/observerly/alpacago/pkg/alpacago/alpaca.go:346.2,348.29 2 194
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:348.29,350.3 1 5
-github.com/observerly/alpacago/pkg/alpacago/alpaca.go:352.2,354.12 2 188
+github.com/observerly/alpacago/pkg/alpacago/alpaca.go:352.2,354.12 2 189
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:363.96,365.2 1 1
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:373.101,375.2 1 6
 github.com/observerly/alpacago/pkg/alpacago/alpaca.go:383.100,385.2 1 1
@@ -283,87 +283,88 @@ github.com/observerly/alpacago/pkg/alpacago/telescope.go:206.46,208.2 1 1
 github.com/observerly/alpacago/pkg/alpacago/telescope.go:216.46,218.2 1 1
 github.com/observerly/alpacago/pkg/alpacago/telescope.go:226.51,228.2 1 1
 github.com/observerly/alpacago/pkg/alpacago/telescope.go:236.49,238.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:246.62,254.16 4 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:254.16,256.3 1 0
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:259.2,259.20 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:259.20,262.3 2 0
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:265.2,267.26 2 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:276.45,278.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:286.51,288.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:296.59,298.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:306.54,308.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:316.48,318.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:326.52,328.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:336.62,338.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:346.52,348.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:356.45,358.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:366.50,368.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:376.55,378.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:386.50,388.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:396.45,398.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:406.50,408.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:416.47,418.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:426.37,435.2 3 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:444.39,453.2 3 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:463.55,465.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:473.59,475.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:483.71,493.2 3 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:501.52,503.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:513.66,523.2 3 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:531.69,534.2 2 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:542.55,544.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:552.52,554.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:563.58,565.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:573.62,575.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:583.77,593.2 3 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:601.63,604.2 2 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:612.70,615.40 2 3
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:615.40,617.3 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:619.2,625.70 2 2
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:634.56,636.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:644.57,646.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:655.67,658.52 2 3
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:658.52,660.3 1 2
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:662.2,668.73 2 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:677.56,679.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:687.65,690.47 2 3
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:690.47,692.3 1 2
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:694.2,700.72 2 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:709.57,711.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:719.67,722.51 2 3
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:722.51,724.3 1 2
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:726.2,732.73 2 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:742.47,744.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:752.56,754.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:762.67,772.2 3 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:780.77,785.37 3 3
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:785.37,787.3 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:789.2,789.34 1 2
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:789.34,791.3 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:793.2,800.71 2 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:810.82,815.37 3 3
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:815.37,817.3 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:819.2,819.34 1 2
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:819.34,821.3 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:823.2,830.76 2 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:840.93,845.43 3 3
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:845.43,847.3 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:849.2,849.48 1 2
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:849.48,851.3 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:853.2,862.77 3 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:872.98,877.43 3 3
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:877.43,879.3 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:881.2,881.48 1 2
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:881.48,883.3 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:885.2,894.82 3 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:904.45,915.2 4 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:925.50,936.2 4 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:944.61,946.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:954.75,964.2 3 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:972.64,974.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:982.81,992.2 3 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:1000.48,1002.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:1010.54,1020.2 3 15
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:1028.54,1030.2 1 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:1041.53,1045.2 3 1
-github.com/observerly/alpacago/pkg/alpacago/telescope.go:1056.57,1069.2 4 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:246.38,255.2 3 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:263.62,271.16 4 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:271.16,273.3 1 0
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:276.2,276.20 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:276.20,279.3 2 0
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:282.2,284.26 2 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:293.45,295.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:303.51,305.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:313.59,315.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:323.54,325.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:333.48,335.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:343.52,345.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:353.62,355.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:363.52,365.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:373.45,375.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:383.50,385.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:393.55,395.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:403.50,405.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:413.45,415.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:423.50,425.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:433.47,435.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:443.37,452.2 3 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:461.39,470.2 3 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:480.55,482.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:490.59,492.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:500.71,510.2 3 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:518.52,520.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:530.66,540.2 3 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:548.69,551.2 2 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:559.55,561.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:569.52,571.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:580.58,582.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:590.62,592.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:600.77,610.2 3 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:618.63,621.2 2 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:629.70,632.40 2 3
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:632.40,634.3 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:636.2,642.70 2 2
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:651.56,653.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:661.57,663.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:672.67,675.52 2 3
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:675.52,677.3 1 2
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:679.2,685.73 2 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:694.56,696.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:704.65,707.47 2 3
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:707.47,709.3 1 2
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:711.2,717.72 2 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:726.57,728.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:736.67,739.51 2 3
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:739.51,741.3 1 2
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:743.2,749.73 2 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:759.47,761.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:769.56,771.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:779.67,789.2 3 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:797.77,802.37 3 3
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:802.37,804.3 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:806.2,806.34 1 2
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:806.34,808.3 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:810.2,817.71 2 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:827.82,832.37 3 3
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:832.37,834.3 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:836.2,836.34 1 2
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:836.34,838.3 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:840.2,847.76 2 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:857.93,862.43 3 3
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:862.43,864.3 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:866.2,866.48 1 2
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:866.48,868.3 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:870.2,879.77 3 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:889.98,894.43 3 3
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:894.43,896.3 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:898.2,898.48 1 2
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:898.48,900.3 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:902.2,911.82 3 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:921.45,932.2 4 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:942.50,953.2 4 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:961.61,963.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:971.75,981.2 3 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:989.64,991.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:999.81,1009.2 3 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:1017.48,1019.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:1027.54,1037.2 3 15
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:1045.54,1047.2 1 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:1058.53,1062.2 3 1
+github.com/observerly/alpacago/pkg/alpacago/telescope.go:1073.57,1086.2 4 1

pkg/alpacago/alpaca_test.go

@@ -152,7 +152,7 @@ func TestNewAlpacaAPIFloat64Response(t *testing.T) {
 func TestNewAlpacaAPIInt32Response(t *testing.T) {
 	got, err := client.GetInt32Response("telescope", 0, "alignmentmode")
 
-	var want int32 = 2
+	var want int32 = 1
 
 	if err != nil {
 		t.Errorf("got %q, wanted %d", err, want)

pkg/alpacago/telescope.go

@@ -237,6 +237,23 @@ func (t *Telescope) CanFindHome() (bool, error) {
 	return t.Alpaca.GetBooleanResponse("telescope", t.DeviceNumber, "canfindhome")
 }
 
+/*
+FindHome()
+
+@returns an error or nil, if nil it puts the telescope into the homed state.
+@see https://ascom-standards.org/api/#/Telescope%20Specific%20Methods/put_telescope__device_number__findhome
+*/
+func (t *Telescope) FindHome() error {
+	t.Alpaca.TransactionId++
+
+	var form map[string]string = map[string]string{
+		"ClientID":            fmt.Sprintf("%d", t.Alpaca.ClientId),
+		"ClientTransactionID": fmt.Sprintf("%d", t.Alpaca.TransactionId),
+	}
+
+	return t.Alpaca.Put("telescope", t.DeviceNumber, "findhome", form)
+}
+
 /*
 CanMoveAxis()
 

pkg/alpacago/telescope_test.go

@@ -151,7 +151,7 @@ func TestNewTelescopeSetAbortSlew(t *testing.T) {
 func TestNewTelescopeAlignmentMode(t *testing.T) {
 	var got, err = telescope.GetAlignmentMode()
 
-	var want = AlignmentGermanPolar
+	var want = AlignmentPolar
 
 	if err != nil {
 		t.Errorf("got %q, wanted %q", err, want)
@@ -313,6 +313,14 @@ func TestNewTelescopeCanFindHome(t *testing.T) {
 	}
 }
 
+func TestNewTelescopeFindHome(t *testing.T) {
+	var err = telescope.FindHome()
+
+	if err != nil {
+		t.Errorf("got %q", err)
+	}
+}
+
 func TestNewTelescopeCanMoveAxis(t *testing.T) {
 	var got, err = telescope.CanMoveAxis(0)