set_by_gain

Configure the selected PID controller using gain coefficients.

The PID instrument contains two cascaded PID sections. Using this function sets the overall gains of the two sections in an optimal way. If you wish to set them individually, including configuring double-integrators, see `set_by_gain_and_section`.

Parameters

strict boolean

Disable all implicit conversions and coercions.

default: true

channel integer required

Target channel

allowed values:

Moku:Lab	1, 2
Moku:Go	1, 2
Moku:Pro	1, 2, 3, 4

overall_gain number

Overall Gain

default: undefined

units: dB

prop_gain number required

Proportional gain factor

units: dB

int_gain number required

Integrator gain factor

units: dB

diff_gain number required

Differentiator gain factor

units: dB

int_corner number required

Integrator gain saturation corner

units: Hz

diff_corner number required

Differentiator gain saturation corner

units: Hz

Examples

Sample response

[
    {
        "diff_corner": 100.0,
        "diff_gain": 0.0,
        "int_corner": 5.0,
        "int_gain": 40.0,
        "overall_gain": 6.0,
        "prop_gain": 20.0
    },
    {
        "diff_corner": 1000000.0,
        "diff_gain": -60.0,
        "int_corner": 10000.0,
        "int_gain": 60.0,
        "overall_gain": 6.0,
        "prop_gain": 20.0
    }
]