My Marlin configs for Fabrikator Mini and CTC i3 Pro B
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.

twibus.h 4.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. /*
  2. * Marlin 3D Printer Firmware
  3. * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. #ifndef TWIBUS_H
  23. #define TWIBUS_H
  24. #include "macros.h"
  25. // Print debug messages with M111 S2 (Uses 236 bytes of PROGMEM)
  26. //#define DEBUG_TWIBUS
  27. /**
  28. * TWIBUS class
  29. *
  30. * This class implements a wrapper around the two wire (I2C) bus, it allows
  31. * Marlin to send and request data from any slave device on the bus. This is
  32. * an experimental feature and it's inner workings as well as public facing
  33. * interface are prune to change in the future.
  34. *
  35. * The two main consumers of this class are M155 and M156, where M155 allows
  36. * Marlin to send a I2C packet to a device (please be aware that no repeated
  37. * starts are possible), this can be done in caching method by calling multiple
  38. * times M155 B<byte-1 value in base 10> or a one liner M155, have a look at
  39. * the gcode_M155() function for more information. M156 allows Marlin to
  40. * request data from a device, the received data is then relayed into the serial
  41. * line for host interpretation.
  42. *
  43. */
  44. class TWIBus {
  45. private:
  46. /**
  47. * @brief Timeout value in milliseconds
  48. * @details For blocking operations this constant value will set the max
  49. * amount of time Marlin will keep waiting for a reply. Useful is something
  50. * goes wrong on the bus and the SDA/SCL lines are held up by another device.
  51. */
  52. const int timeout = 5;
  53. /**
  54. * @brief Target device address
  55. * @description This stores, until the buffer is flushed, the target device
  56. * address, take not we do follow Arduino 7bit addressing.
  57. */
  58. uint8_t addr = 0;
  59. /**
  60. * @brief Number of bytes on buffer
  61. * @description This var holds the total number of bytes on our buffer
  62. * waiting to be flushed to the bus.
  63. */
  64. uint8_t buffer_s = 0;
  65. /**
  66. * @brief Internal buffer
  67. * @details This is a fixed buffer, TWI command cannot be longer than this
  68. */
  69. char buffer[30];
  70. public:
  71. /**
  72. * @brief Class constructor
  73. * @details Initialized the TWI bus and clears the buffer
  74. */
  75. TWIBus();
  76. /**
  77. * @brief Reset the buffer
  78. * @details Brings the internal buffer to a known-empty state
  79. */
  80. void reset();
  81. /**
  82. * @brief Send the buffer data to the bus
  83. * @details Flushed the buffer into the bus targeting the cached slave device
  84. * address.
  85. */
  86. void send();
  87. /**
  88. * @brief Add one byte to the buffer
  89. * @details Adds the byte to the buffer in a sequential way, if buffer is full
  90. * the request is silently ignored.
  91. *
  92. * @param c a data byte
  93. */
  94. void addbyte(char c);
  95. /**
  96. * @brief Sets the target slave address
  97. * @details The target slave address is stored so it can be later used when
  98. * the complete packet needs to be sent over the bus.
  99. *
  100. * @param addr 7-bit integer address
  101. */
  102. void address(uint8_t addr);
  103. /**
  104. * @brief Request data from slave device
  105. * @details Requests data from a slave device, when the data is received it will
  106. * be relayed to the serial line using a parser-friendly formatting.
  107. *
  108. * @param bytes the number of bytes to request
  109. */
  110. void reqbytes(uint8_t bytes);
  111. #if ENABLED(DEBUG_TWIBUS)
  112. /**
  113. * @brief Prints a debug message
  114. * @details Prints a simple debug message "TWIBus::function: value"
  115. */
  116. static void debug(const char func[], int32_t val = -1);
  117. #endif
  118. };
  119. #endif //TWIBUS_H