TimerInstance_Class

setPeriodMilliseconds()

Description

This method sets the period, in milisseconds, for a timer callback (periodic call).

How does it work?
this function sets the most appropriate prescaler divider (if timer has prescaler enabled) and calculates the comparator value corresponding to the given period in millisecond. Otherwise it returns -1. It sets also the timer counter to zero and enables updirection mode.

Syntax

timer1.setPeriodMilliseconds(ms)

Parameters

timer1: a variable of type TimerInstance_Class

ms: the number of milisseconds requested. type: unsigned,

See also

Corrections, suggestions, and new documentation can be added directly to the wiki page. Scroll to the bottom, choose "Edit Page" and use "Papilio" as the password.

  

Share |