Move get_startup into the package

Author: ufechner7

docs/src/functions.md

@@ -7,4 +7,5 @@ CurrentModule = WinchControllers
 @limit
 saturate
 merge_angles
+get_startup
 ```

src/WinchControllers.jl

@@ -18,9 +18,9 @@ abstract type AbstractForceController end
 const AFC = AbstractForceController
 
 # Write your package code here.
+include("wc_settings.jl")
 include("utils.jl")
 include("components.jl")
-include("wc_settings.jl")
 include("wc_components.jl")
 include("winchcontroller.jl")
 

src/utils.jl

@@ -7,6 +7,7 @@ Functions:
 - limit 
 - merge_angles
 - moving_average
+- get_startup
 
 Implemented as described in the PhD thesis of Uwe Fechner.
 """
@@ -88,4 +89,35 @@ function moving_average(data, window)
         result = mean(data[length(data)-window:end])
     end
     result
+end
+
+
+"""
+    get_startup(wcs::WCSettings, samples)
+
+Create a signal, that is rising with wcs.t_startup from zero to one and then stays constant.
+
+## Parameters:
+- wcs: the winch controller settings
+- samples: the number of samples to create
+
+## Returns:
+- a vector of length `samples` with the startup signal
+"""
+function get_startup(wcs::WCSettings, samples)
+    result = zeros(samples)
+    startup = 0.0
+    rising = true
+    delta = wcs.dt/wcs.t_startup
+    for i in 1:samples
+        result[i] = startup
+        if rising
+            startup += delta
+        end
+        if startup >= 1.0
+            startup = 1.0
+            rising = false
+        end
+    end
+    result
 end

test/test_utilities.jl

@@ -1,22 +1,3 @@
-# Create a signal, that is rising with wcs.t_startup from zero to one and then stays constant.
-function get_startup(wcs::WCSettings, samples)
-    result = zeros(samples)
-    startup = 0.0
-    rising = true
-    delta = wcs.dt/wcs.t_startup
-    for i in 1:samples
-        result[i] = startup
-        if rising
-            startup += delta
-        end
-        if startup >= 1.0
-            startup = 1.0
-            rising = false
-        end
-    end
-    result
-end
-
 # Create a wind signal in triangle form, using the constants V_WIND_MIN and V_WIND_MAX with
 # the frequency FREQ_WIND.
 function  get_triangle_wind(wcs::WCSettings)