summaryrefslogtreecommitdiff
path: root/inc/resource/resource_led.h
diff options
context:
space:
mode:
Diffstat (limited to 'inc/resource/resource_led.h')
-rwxr-xr-xinc/resource/resource_led.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/inc/resource/resource_led.h b/inc/resource/resource_led.h
index 44b058a..1a81a18 100755
--- a/inc/resource/resource_led.h
+++ b/inc/resource/resource_led.h
@@ -17,8 +17,18 @@
#ifndef __POSITION_FINDER_RESOURCE_LED_H__
#define __POSITION_FINDER_RESOURCE_LED_H__
+/**
+ * @brief Writes value of gpio connected led light
+ * @param[in] pin_num The gpio pin number for the led light
+ * @param[out] out_value The value of turniing the led light on/off
+ * @return 0 on success, otherwise a negative error value
+ * @see If the gpio pin is not open, create gpio handle before writing the value
+ */
extern int resource_write_led(int pin_num, int write_value);
+/**
+ * @brief Releases the gpio handle
+ */
extern void resource_close_led(void);
#endif /* __POSITION_FINDER_RESOURCE_LED_H__ */