Apps     Components     Interfaces     All Files     Source Tree     source: tos.interfaces.HPLPot.nc

Interface: HPLPot

Interface to a variable potentiometer. Calls to increase and decrease must be actualized with a call to finalise

Because this is a direct hardware interface, it does not maintain state; checks for potentiometer bounds must be performed by a higher-level interface.

Components providing this interface:
tos.platform.avrmote.HPLPotC

Components requiring this interface:
tos.system.PotM

Commands

Commands - Details

decrease

result_t decrease(void)

Decrease the resistance by one unit.
Returns: SUCCESS always.

increase

result_t increase(void)

Increase the resistance by one unit.
Returns: SUCCESS always.

finalise

result_t finalise(void)

Finalize the adjusted value.
Returns: SUCCESS always.