Skip to main content

pin.getsteps()

Returns the step-count of a pin in PWM mode

Availability

Device

Returns

Integer — the PWM step-count

Description

This method provides the actual number of Pulse-Width Modulation steps that have been configured in hardware. Like pin.getperiod(), this may not be exactly the value specified in pin.configure(), due to rounding and/or whether the pin was configured as PWM_OUT, which gives priority to providing the period accurately, or PWM_OUT_STEPS, which gives priority to providing an accurate number of steps. Either option is a trade-off.

A Squirrel runtime error, the index ‘getsteps’ does not exist, occurs if the call is made to a pin that does not support PWM. If the pin does support PWM, but has been configured to another function, this method returns 0.

pin.getsteps() provides the number of steps even if the PWM is running in ‘zombie’ mode, ie. it continues to operate across Squirrel reloads, firmware upgrades and device restarts.

Note The imp005 only supports PWM on GPIO pins from impOS™ 36 and up.