From 47a9c3d74f86820fca04244dfd0452efa159366b Mon Sep 17 00:00:00 2001 From: davidhozic Date: Tue, 13 Jul 2021 19:11:03 +0200 Subject: [PATCH] Update README.md --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9bb5af7..0f067d1 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,10 @@ The LITL library - Linked-list, Input, Timer, Library - INPUT: - An input class for avr inputs - Supports: Rising Edge, Falling Edge, Filtering (requres castimer) - - Initialization : INPUT_t example("pin","port", bool invert state); or INPUT_t example = INPUT_t(pin,'port letter', bool invert state); - If invert state is set to 1, the input's value will be inverted from the PIN register value + - Initialization : INPUT_t example("pin","port", bool invert state); + INPUT_t example = INPUT_t(pin,'port letter', bool invert state); + If invert state is set to 1, the input's value will be inverted from the PIN register value + - Functions: - bool value(); -> Returns value of the input - bool risen_edge(); -> Returns 1 if input went from 0 to 1 from the last function call, the risen edge bit is cleared if this function is called or if input is 0 @@ -16,6 +18,9 @@ The LITL library - Linked-list, Input, Timer, Library - TIMER: - An universal timer class, if on interrupt mode, then it will only work on avr. - Supports interrupt mode (every timer is incremented in an ISR) or system time mode (time difference) + - Initialization : TIMER_t your_timer; + TIMER_t your_timer = TIMER_t(); + - Functions: - uint32_t value(); -> Starts the timer and returns the value - void reset(); -> Resets the timer and disables it @@ -24,6 +29,8 @@ The LITL library - Linked-list, Input, Timer, Library - A high language like linked list - It uses a TEMPLATE PARAMETER meaning you can tell it what the variable type will be. - Does not require the STL library making it compatible with platforms, even those that don't support DLLs. + - Initialization : LIST_t list_name; + LIST_t list_name = LIST_t (); ------------------------------------------------------------------------------------------- LINKED LIST FUNCTIONS