md__r_e_a_d_m_e.tex 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. This is an easy to use Arduino library for A\+DC Converter \mbox{\hyperlink{class_a_d_s1118}{A\+D\+S1118}}
  2. \subsection*{Getting Started}
  3. Learn with the examples provided\+: For basic use \char`\"{}basic\+Example\+Ads1118\char`\"{} and \char`\"{}ads1118example\char`\"{} for a detailed use.
  4. \subsubsection*{Prerequisites}
  5. None
  6. \subsubsection*{Installing}
  7. Download or clone this project in the \char`\"{}libraries\char`\"{} folder of your Arduino folder.
  8. \#\# Running the tests
  9. \begin{DoxyCode}
  10. Connect the ADS1118 in the 3.3v power supply pins of your Arduino.
  11. \end{DoxyCode}
  12. \begin{DoxyCode}
  13. Connect the ADS1118 CS pin to the pin 5 of your Arduino.
  14. \end{DoxyCode}
  15. \begin{DoxyCode}
  16. Connect the ADS1118 MISO (DOUT), MOSI(DIN) and SCLK pins to the MISO, MOSI and SCLK of your Arduino (search
  17. on internet "Arduino ICSP pinout").
  18. -------------------------------------------------------
  19. |ARDUINO (ICSP PINS) |ADS1118 PINS |
  20. -------------------------------------------------------
  21. | MOSI | DIN |
  22. | MISO | DOUT |
  23. | SCLK | SCLK |
  24. | 5 (change this pin to fit your needs) | CS |
  25. -------------------------------------------------------
  26. \end{DoxyCode}
  27. \begin{DoxyCode}
  28. Run the examples provided in your Arduino IDE.
  29. \end{DoxyCode}
  30. \subsection*{Built With}
  31. \begin{DoxyItemize}
  32. \item \href{https://www.arduino.cc/}{\tt Arduino I\+DE}
  33. \end{DoxyItemize}
  34. \subsection*{Contributing}
  35. Everyone is invited to contribute When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with me before making a change.
  36. \subsection*{Versioning}
  37. I am using \href{http://semver.org/}{\tt Sem\+Ver} for versioning.
  38. \subsection*{Authors}
  39. \begin{DoxyItemize}
  40. \item {\bfseries Alvaro Salazar} -\/ {\itshape Initial work} -\/ \href{https://github.com/alvaro-salazar}{\tt alvaro-\/salazar}
  41. \end{DoxyItemize}
  42. \subsection*{License}
  43. This project is licensed under the M\+IT License -\/ see the L\+I\+C\+E\+N\+SE.md file for details.