Some progress

Author: ufechner7

docs/make.jl

@@ -15,8 +15,8 @@ makedocs(;
     ),
     pages=[
         "Home" => "index.md",
-        "Components" => "components.md",
-        "Types" => "types.md",
+        "Generic Components" => "components.md",
+        "Winchcontroller" => "winchcontroller.md",
         "Functions" => "functions.md"
     ],
 )

docs/src/components.md

@@ -27,8 +27,12 @@ calc_output(rl::RateLimiter, input)
 on_timer(rl::RateLimiter)
 ```
 
-## CalcVSetIn
+## Mixer_2CH
 ```@docs
-set_vset_pc(cvi::CalcVSetIn, v_set_pc, force)
-calc_output(cvi::CalcVSetIn)
+Mixer_2CH
+```
+
+## Mixer_3CH
+```@docs
+Mixer_3CH
 ```

docs/src/types.md

@@ -0,0 +1,19 @@
+```@meta
+CurrentModule = WinchControllers
+```
+
+## Control components
+### CalcVSetIn
+```@docs
+CalcVSetIn
+CalcVSetIn(wcs::WCSettings)
+set_vset_pc(cvi::CalcVSetIn, v_set_pc, force)
+calc_output(cvi::CalcVSetIn)
+on_timer(cvi::CalcVSetIn)
+```
+
+## Controller and settings
+```@docs
+WinchController
+WCSettings
+```

docs/src/winchcontroller.md

@@ -32,7 +32,7 @@ end
 Constructor for discrete integrator with external reset.
 
 # Parameters
-- dt: timestep [s]
+- dt: time-step [s]
 - i:  integration constant
 - x0: initial and last output
 

src/components.jl

@@ -12,14 +12,33 @@ Components:
 Implemented as described in the PhD thesis of Uwe Fechner.
 """
 
-# Component for calculation v_set_in, using soft switching.
+"""
+    mutable struct CalcVSetIn
+
+Component for calculation v_set_in, using soft switching.
+
+# Fields
+
+$(TYPEDFIELDS)
+"""
 @with_kw mutable struct CalcVSetIn @deftype Float64
     wcs::WCSettings
     mixer2::Mixer_2CH = Mixer_2CH(wcs.dt, wcs.t_blend)
     input_a     = 0
     input_b     = 0
 end
 
+"""
+    function CalcVSetIn(wcs::WCSettings)
+
+Constructor for component for calculation `v_set_in`, using soft switching.
+
+# Parameters
+- wcs:: WCSettings: settings struct with the winch controller settings
+
+# Returns
+- a new struct of type `CalcVSetIn`
+"""
 function CalcVSetIn(wcs::WCSettings)
     CalcVSetIn(wcs=wcs)
 end
@@ -83,8 +102,20 @@ function calc_output(cvi::CalcVSetIn)
     calc_output(cvi.mixer2, cvi.input_a, cvi.input_b)
 end
 
+"""
+    on_timer(cvi::CalcVSetIn)
+
+Update the mixer. Must be called once per time-step.
+
+# Parameters
+- cvi::CalcVSetIn: Reference to the CalcVSetIn component
+
+# Returns
+- nothing
+"""
 function on_timer(cvi::CalcVSetIn)
     on_timer(cvi.mixer2)
+    nothing
 end
 
 # Class, that calculates the acceleration of the tether based on the tether force