Fork of the espurna firmware for `mhsw` switches
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

474 lines
16 KiB

  1. // -----------------------------------------------------------------------------
  2. // Configuration HELP
  3. // -----------------------------------------------------------------------------
  4. //
  5. // MANUFACTURER: Name of the manufacturer of the board ("string")
  6. // DEVICE: Name of the device ("string")
  7. // BUTTON#_PIN: GPIO for the n-th button (1-based, up to 4 buttons)
  8. // BUTTON#_RELAY: Relay number that will be bind to the n-th button (1-based)
  9. // BUTTON#_MODE: A mask of options (BUTTON_PUSHBUTTON and BUTTON_SWITCH cannot be together)
  10. // - BUTTON_PUSHBUTTON: button event is fired when released
  11. // - BUTTON_SWITCH: button event is fired when pressed or released
  12. // - BUTTON_DEFAULT_HIGH: there is a pull up in place
  13. // - BUTTON_SET_PULLUP: set pullup by software
  14. // RELAY#_PIN: GPIO for the n-th relay (1-based, up to 4 relays)
  15. // RELAY#_PIN_INVERSE: Relay has inversed logic (closed or ON when pulled down)
  16. // RELAY#_LED: LED number that will be bind to the n-th relay (1-based)
  17. // LED#_PIN: GPIO for the n-th LED (1-based, up to 4 LEDs)
  18. // LED#_PIN_INVERSE: LED has inversed logic (lit when pulled down)
  19. // WIFI_LED: LED number that will used for WIFI notifications (1-based, defaults to 1)
  20. // -----------------------------------------------------------------------------
  21. // Development boards
  22. // -----------------------------------------------------------------------------
  23. #if defined(NODEMCUV2)
  24. #define MANUFACTURER "NODEMCU"
  25. #define DEVICE "LOLIN"
  26. #define BUTTON1_PIN 0
  27. #define BUTTON1_RELAY 1
  28. #define BUTTON1_LNGCLICK BUTTON_MODE_PULSE
  29. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  30. #define RELAY1_PIN 12
  31. #define RELAY1_PIN_INVERSE 0
  32. #define LED1_PIN 2
  33. #define LED1_PIN_INVERSE 1
  34. #elif defined(D1_RELAYSHIELD)
  35. #define MANUFACTURER "WEMOS"
  36. #define DEVICE "D1_MINI"
  37. #define RELAY1_PIN 5
  38. #define RELAY1_PIN_INVERSE 0
  39. #define LED1_PIN 2
  40. #define LED1_PIN_INVERSE 1
  41. // -----------------------------------------------------------------------------
  42. // ESPurna
  43. // -----------------------------------------------------------------------------
  44. #elif defined(ESPURNA_H)
  45. #define MANUFACTURER "TINKERMAN"
  46. #define DEVICE "ESPURNA_H"
  47. #define RELAY1_PIN 12
  48. #define RELAY1_PIN_INVERSE 1
  49. #define LED1_PIN 5
  50. #define LED1_PIN_INVERSE 0
  51. #define BUTTON1_PIN 4
  52. #define BUTTON1_RELAY 1
  53. #define BUTTON1_MODE BUTTON_SWITCH
  54. #define ENABLE_POW 1
  55. // -----------------------------------------------------------------------------
  56. // Itead Studio boards
  57. // -----------------------------------------------------------------------------
  58. #elif defined(SONOFF)
  59. #define MANUFACTURER "ITEAD"
  60. #define DEVICE "SONOFF"
  61. #define BUTTON1_PIN 0
  62. #define BUTTON1_RELAY 1
  63. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  64. #define RELAY1_PIN 12
  65. #define RELAY1_PIN_INVERSE 0
  66. #define LED1_PIN 13
  67. #define LED1_PIN_INVERSE 1
  68. #elif defined(SONOFF_TH)
  69. #define MANUFACTURER "ITEAD"
  70. #define DEVICE "SONOFF_TH"
  71. #define BUTTON1_PIN 0
  72. #define BUTTON1_RELAY 1
  73. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  74. #define RELAY1_PIN 12
  75. #define RELAY1_PIN_INVERSE 0
  76. #define LED1_PIN 13
  77. #define LED1_PIN_INVERSE 1
  78. #elif defined(SONOFF_SV)
  79. #define MANUFACTURER "ITEAD"
  80. #define DEVICE "SONOFF_SV"
  81. #define BUTTON1_PIN 0
  82. #define BUTTON1_RELAY 1
  83. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  84. #define RELAY1_PIN 12
  85. #define RELAY1_PIN_INVERSE 0
  86. #define LED1_PIN 13
  87. #define LED1_PIN_INVERSE 1
  88. #elif defined(SLAMPHER)
  89. #define MANUFACTURER "ITEAD"
  90. #define DEVICE "SLAMPHER"
  91. #define BUTTON1_PIN 0
  92. #define BUTTON1_RELAY 1
  93. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  94. #define RELAY1_PIN 12
  95. #define RELAY1_PIN_INVERSE 0
  96. #define LED1_PIN 13
  97. #define LED1_PIN_INVERSE 1
  98. #elif defined(S20)
  99. #define MANUFACTURER "ITEAD"
  100. #define DEVICE "S20"
  101. #define BUTTON1_PIN 0
  102. #define BUTTON1_RELAY 1
  103. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  104. #define RELAY1_PIN 12
  105. #define RELAY1_PIN_INVERSE 0
  106. #define LED1_PIN 13
  107. #define LED1_PIN_INVERSE 1
  108. #elif defined(SONOFF_TOUCH)
  109. #define MANUFACTURER "ITEAD"
  110. #define DEVICE "SONOFF_TOUCH"
  111. #define BUTTON1_PIN 0
  112. #define BUTTON1_RELAY 1
  113. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  114. #define RELAY1_PIN 12
  115. #define RELAY1_PIN_INVERSE 0
  116. #define LED1_PIN 13
  117. #define LED1_PIN_INVERSE 1
  118. #elif defined(SONOFF_POW)
  119. #define MANUFACTURER "ITEAD"
  120. #define DEVICE "SONOFF_POW"
  121. #define BUTTON1_PIN 0
  122. #define BUTTON1_RELAY 1
  123. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  124. #define RELAY1_PIN 12
  125. #define RELAY1_PIN_INVERSE 0
  126. #define LED1_PIN 15
  127. #define LED1_PIN_INVERSE 0
  128. #define ENABLE_POW 1
  129. #elif defined(SONOFF_DUAL)
  130. #define MANUFACTURER "ITEAD"
  131. #define DEVICE "SONOFF_DUAL"
  132. #define BUTTON3_RELAY 1
  133. #define LED1_PIN 13
  134. #define LED1_PIN_INVERSE 1
  135. #undef SERIAL_BAUDRATE
  136. #define SERIAL_BAUDRATE 19230
  137. #undef RELAY_PROVIDER
  138. #define RELAY_PROVIDER RELAY_PROVIDER_DUAL
  139. #elif defined(SONOFF_4CH)
  140. #define MANUFACTURER "ITEAD"
  141. #define DEVICE "SONOFF_4CH"
  142. #define BUTTON1_PIN 0
  143. #define BUTTON1_RELAY 1
  144. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  145. #define BUTTON2_PIN 9
  146. #define BUTTON2_RELAY 2
  147. #define BUTTON2_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  148. #define BUTTON3_PIN 10
  149. #define BUTTON3_RELAY 3
  150. #define BUTTON3_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  151. #define BUTTON4_PIN 14
  152. #define BUTTON4_RELAY 4
  153. #define BUTTON4_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  154. #define RELAY1_PIN 12
  155. #define RELAY1_PIN_INVERSE 0
  156. #define RELAY2_PIN 5
  157. #define RELAY2_PIN_INVERSE 0
  158. #define RELAY3_PIN 4
  159. #define RELAY3_PIN_INVERSE 0
  160. #define RELAY4_PIN 15
  161. #define RELAY4_PIN_INVERSE 0
  162. #define LED1_PIN 13
  163. #define LED1_PIN_INVERSE 1
  164. #elif defined(ITEAD_1CH_INCHING)
  165. // The inching functionality is managed by a misterious IC in the board.
  166. // You cannot control the inching button and functionality from the ESP8266
  167. // Besides, enabling the inching functionality using the hardware button
  168. // will result in the relay switching on and off continuously.
  169. // Fortunately the unkown IC keeps memory of the hardware inching status
  170. // so you can just disable it and forget. The inching LED must be lit.
  171. // You can still use the pulse options from the web interface
  172. // without problem.
  173. #define MANUFACTURER "ITEAD"
  174. #define DEVICE "1CH_INCHING"
  175. #define BUTTON1_PIN 0
  176. #define BUTTON1_RELAY 1
  177. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  178. #define RELAY1_PIN 12
  179. #define RELAY1_PIN_INVERSE 0
  180. #define LED1_PIN 13
  181. #define LED1_PIN_INVERSE 1
  182. #elif defined(ITEAD_MOTOR)
  183. #define MANUFACTURER "ITEAD"
  184. #define DEVICE "MOTOR"
  185. #define BUTTON1_PIN 0
  186. #define BUTTON1_RELAY 1
  187. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  188. #define RELAY1_PIN 12
  189. #define RELAY1_PIN_INVERSE 0
  190. #define LED1_PIN 13
  191. #define LED1_PIN_INVERSE 1
  192. // -----------------------------------------------------------------------------
  193. // Electrodragon boards
  194. // -----------------------------------------------------------------------------
  195. #elif defined(ESP_RELAY_BOARD)
  196. #define MANUFACTURER "ELECTRODRAGON"
  197. #define DEVICE "ESP_RELAY_BOARD"
  198. #define BUTTON1_PIN 0
  199. #define BUTTON1_RELAY 1
  200. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  201. #define BUTTON2_PIN 2
  202. #define BUTTON2_RELAY 2
  203. #define BUTTON2_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  204. #define RELAY1_PIN 12
  205. #define RELAY1_PIN_INVERSE 0
  206. #define RELAY2_PIN 13
  207. #define RELAY2_PIN_INVERSE 0
  208. #define LED1_PIN 16
  209. #define LED1_PIN_INVERSE 0
  210. // -----------------------------------------------------------------------------
  211. // WorkChoice ecoPlug
  212. // -----------------------------------------------------------------------------
  213. #elif defined(ECOPLUG)
  214. #define MANUFACTURER "WORKCHOICE"
  215. #define DEVICE "ECOPLUG"
  216. #define BUTTON1_PIN 13
  217. #define BUTTON1_RELAY 1
  218. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  219. #define RELAY1_PIN 15
  220. #define RELAY1_PIN_INVERSE 0
  221. #define LED1_PIN 2
  222. #define LED1_PIN_INVERSE 0
  223. // -----------------------------------------------------------------------------
  224. // AI Thinker
  225. // -----------------------------------------------------------------------------
  226. #elif defined(AI_LIGHT)
  227. #define MANUFACTURER "AI_THINKER"
  228. #define DEVICE "AI_LIGHT"
  229. #define RELAY_PROVIDER RELAY_PROVIDER_LIGHT
  230. #define LIGHT_PROVIDER LIGHT_PROVIDER_MY9192
  231. // -----------------------------------------------------------------------------
  232. // LED Controller
  233. // -----------------------------------------------------------------------------
  234. #elif defined(LED_CONTROLLER)
  235. #define MANUFACTURER "MAGIC_HOME"
  236. #define DEVICE "LED_CONTROLLER"
  237. #define LED1_PIN 2
  238. #define LED1_PIN_INVERSE 1
  239. #define RELAY_PROVIDER RELAY_PROVIDER_LIGHT
  240. #define LIGHT_PROVIDER LIGHT_PROVIDER_RGB
  241. // -----------------------------------------------------------------------------
  242. // Jan Goedeke Wifi Relay
  243. // https://github.com/JanGoe/esp8266-wifi-relay
  244. // -----------------------------------------------------------------------------
  245. #elif defined(WIFI_RELAY_NC)
  246. #define MANUFACTURER "JAN_GOEDEKE"
  247. #define DEVICE "WIFI_RELAY_NC"
  248. #define BUTTON1_PIN 12
  249. #define BUTTON1_RELAY 1
  250. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  251. #define BUTTON2_PIN 13
  252. #define BUTTON2_RELAY 2
  253. #define BUTTON2_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  254. #define RELAY1_PIN 2
  255. #define RELAY1_PIN_INVERSE 1
  256. #define RELAY2_PIN 14
  257. #define RELAY2_PIN_INVERSE 1
  258. #elif defined(WIFI_RELAY_NO)
  259. #define MANUFACTURER "JAN_GOEDEKE"
  260. #define DEVICE "WIFI_RELAY_NO"
  261. #define BUTTON1_PIN 12
  262. #define BUTTON1_RELAY 1
  263. #define BUTTON1_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  264. #define BUTTON2_PIN 13
  265. #define BUTTON2_RELAY 2
  266. #define BUTTON2_MODE BUTTON_PUSHBUTTON | BUTTON_DEFAULT_HIGH
  267. #define RELAY1_PIN 2
  268. #define RELAY1_PIN_INVERSE 0
  269. #define RELAY2_PIN 14
  270. #define RELAY2_PIN_INVERSE 0
  271. // -----------------------------------------------------------------------------
  272. // Jorge García Wifi+Relays Board Kit
  273. // https://www.tindie.com/products/jorgegarciadev/wifi--relays-board-kit
  274. // https://github.com/jorgegarciadev/wifikit
  275. // -----------------------------------------------------------------------------
  276. #elif defined(WIFI_RELAYS_BOARD_KIT)
  277. #define MANUFACTURER "JORGE_GARCIA"
  278. #define DEVICE "WIFI_RELAYS_BOARD_KIT"
  279. #define RELAY1_PIN 0
  280. #define RELAY1_PIN_INVERSE 1
  281. #define RELAY2_PIN 2
  282. #define RELAY2_PIN_INVERSE 1
  283. // -----------------------------------------------------------------------------
  284. // WiFi MQTT Relay / Thermostat
  285. // -----------------------------------------------------------------------------
  286. #elif defined(MQTT_RELAY)
  287. #define MANUFACTURER "OPENENERGYMONITOR"
  288. #define DEVICE "MQTT_RELAY"
  289. #define BUTTON1_PIN 0
  290. #define BUTTON1_RELAY 1
  291. #define RELAY1_PIN 12
  292. #define RELAY1_PIN_INVERSE 0
  293. #define LED1_PIN 16
  294. #define LED1_PIN_INVERSE 0
  295. // -----------------------------------------------------------------------------
  296. // Unknown hardware
  297. // -----------------------------------------------------------------------------
  298. #else
  299. #error "UNSUPPORTED HARDWARE!"
  300. #endif
  301. // -----------------------------------------------------------------------------
  302. // Default values
  303. // -----------------------------------------------------------------------------
  304. #ifndef BUTTON1_PRESS
  305. #define BUTTON1_PRESS BUTTON_MODE_NONE
  306. #endif
  307. #ifndef BUTTON2_PRESS
  308. #define BUTTON2_PRESS BUTTON_MODE_NONE
  309. #endif
  310. #ifndef BUTTON3_PRESS
  311. #define BUTTON3_PRESS BUTTON_MODE_NONE
  312. #endif
  313. #ifndef BUTTON4_PRESS
  314. #define BUTTON4_PRESS BUTTON_MODE_NONE
  315. #endif
  316. #ifndef BUTTON1_CLICK
  317. #define BUTTON1_CLICK BUTTON_MODE_TOGGLE
  318. #endif
  319. #ifndef BUTTON2_CLICK
  320. #define BUTTON2_CLICK BUTTON_MODE_TOGGLE
  321. #endif
  322. #ifndef BUTTON3_CLICK
  323. #define BUTTON3_CLICK BUTTON_MODE_TOGGLE
  324. #endif
  325. #ifndef BUTTON4_CLICK
  326. #define BUTTON4_CLICK BUTTON_MODE_TOGGLE
  327. #endif
  328. #ifndef BUTTON1_DBLCLICK
  329. #define BUTTON1_DBLCLICK BUTTON_MODE_AP
  330. #endif
  331. #ifndef BUTTON2_DBLCLICK
  332. #define BUTTON2_DBLCLICK BUTTON_MODE_NONE
  333. #endif
  334. #ifndef BUTTON3_DBLCLICK
  335. #define BUTTON3_DBLCLICK BUTTON_MODE_NONE
  336. #endif
  337. #ifndef BUTTON4_DBLCLICK
  338. #define BUTTON4_DBLCLICK BUTTON_MODE_NONE
  339. #endif
  340. #ifndef BUTTON1_LNGCLICK
  341. #define BUTTON1_LNGCLICK BUTTON_MODE_RESET
  342. #endif
  343. #ifndef BUTTON2_LNGCLICK
  344. #define BUTTON2_LNGCLICK BUTTON_MODE_NONE
  345. #endif
  346. #ifndef BUTTON3_LNGCLICK
  347. #define BUTTON3_LNGCLICK BUTTON_MODE_NONE
  348. #endif
  349. #ifndef BUTTON4_LNGCLICK
  350. #define BUTTON4_LNGCLICK BUTTON_MODE_NONE
  351. #endif
  352. #ifndef BUTTON1_LNGLNGCLICK
  353. #define BUTTON1_LNGLNGCLICK BUTTON_MODE_FACTORY
  354. #endif
  355. #ifndef BUTTON2_LNGLNGCLICK
  356. #define BUTTON2_LNGLNGCLICK BUTTON_MODE_NONE
  357. #endif
  358. #ifndef BUTTON3_LNGLNGCLICK
  359. #define BUTTON3_LNGLNGCLICK BUTTON_MODE_NONE
  360. #endif
  361. #ifndef BUTTON4_LNGLNGCLICK
  362. #define BUTTON4_LNGLNGCLICK BUTTON_MODE_NONE
  363. #endif
  364. #ifndef BUTTON1_RELAY
  365. #define BUTTON1_RELAY 0
  366. #endif
  367. #ifndef BUTTON2_RELAY
  368. #define BUTTON2_RELAY 0
  369. #endif
  370. #ifndef BUTTON3_RELAY
  371. #define BUTTON3_RELAY 0
  372. #endif
  373. #ifndef BUTTON4_RELAY
  374. #define BUTTON4_RELAY 0
  375. #endif
  376. #ifndef RELAY1_LED
  377. #define RELAY1_LED 0
  378. #endif
  379. #ifndef RELAY2_LED
  380. #define RELAY2_LED 0
  381. #endif
  382. #ifndef RELAY3_LED
  383. #define RELAY3_LED 0
  384. #endif
  385. #ifndef RELAY4_LED
  386. #define RELAY4_LED 0
  387. #endif
  388. #ifndef WIFI_LED
  389. #define WIFI_LED 1
  390. #endif
  391. // Needed for ESP8285 boards under Windows using PlatformIO (?)
  392. #ifndef BUTTON_PUSHBUTTON
  393. #define BUTTON_PUSHBUTTON 0
  394. #define BUTTON_SWITCH 1
  395. #define BUTTON_DEFAULT_HIGH 2
  396. #define BUTTON_SET_PULLUP 4
  397. #endif
  398. // Relay providers
  399. #ifndef RELAY_PROVIDER
  400. #define RELAY_PROVIDER RELAY_PROVIDER_RELAY
  401. #endif
  402. // Light provider
  403. #ifndef LIGHT_PROVIDER
  404. #define LIGHT_PROVIDER LIGHT_PROVIDER_NONE
  405. #endif