{"id":16516610,"url":"https://github.com/eadf/esp_mqtt_lcd","last_synced_at":"2025-03-21T08:31:46.078Z","repository":{"id":25983050,"uuid":"29425204","full_name":"eadf/esp_mqtt_lcd","owner":"eadf","description":"ESP8266 displaying mqtt messages on a Nokia 5110 LCD","archived":false,"fork":false,"pushed_at":"2016-03-03T16:49:50.000Z","size":600,"stargazers_count":70,"open_issues_count":1,"forks_count":22,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-03-17T23:13:33.684Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eadf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-18T12:33:43.000Z","updated_at":"2022-10-23T01:41:37.000Z","dependencies_parsed_at":"2022-08-24T14:18:49.093Z","dependency_job_id":null,"html_url":"https://github.com/eadf/esp_mqtt_lcd","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eadf%2Fesp_mqtt_lcd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eadf%2Fesp_mqtt_lcd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eadf%2Fesp_mqtt_lcd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eadf%2Fesp_mqtt_lcd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eadf","download_url":"https://codeload.github.com/eadf/esp_mqtt_lcd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244765415,"owners_count":20506808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-11T16:25:45.837Z","updated_at":"2025-03-21T08:31:45.578Z","avatar_url":"https://github.com/eadf.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# esp_mqtt_lcd\n\nESP8266 displaying mqtt messages on a Nokia 5110 LCD\n\nI'm pulling in several git subtree modules :\n* [tuanpmt's exellent mqtt project: esp_mqtt](https://github.com/tuanpmt/esp_mqtt) \n* [esp8266_pcd8544](https://github.com/eadf/esp8266_pcd8544) the lcd driver\n* [esp8266_easygpio](https://github.com/eadf/esp8266_easygpio) makes it easy to change GPIO pins\n* [esp8266_stdout](https://github.com/eadf/esp8266_stdout) alternative UART implementation (required if you want to connect the lcd with only 3 pins) \n\nGood news, the interface no longer requires 5 available GPIO outputs so an ESP-01 will indeed work. (But only if the RX pin of the esp is used.)\n\n##Usage\nTo use this mqtt enabled LCD you can send text messages to these topics:\n* /lcd0\n* /lcd1\n* /lcd2\n* /lcd3\n* /lcd4\n* /lcd5\n\nRepresenting each row of the display.\n\nThe LCD is also listening to these topics:\n* /lcd/clearscreen\n* /lcd/contrast\n\nYou can also send messages to topics that are unique to each *esp*, look at the debug console for more info.\n\n### Pin configuraton\n\nThis is how the code is hooked up by default:\n\nPCD8544| ESP8266\n-------|------------------\nRST Pin 1 | GPIO4\nCE  Pin 2 | GPIO5\nDC  Pin 3 | GPIO12\nDin Pin 4 | GPIO13\nClk Pin 5 | GPIO14\n\nSome ESP-12 have GPIO4 \u0026 GPIO5 reversed.\n\nThe RST pin is optional, set it to a negative value and tie PCD8544 reset to ESP reset via a resistor.\n\nThe CE pin is optional, set it to a negative value and tie PCD8544 CE pin to GND via a resistor.\n\nAll of the pins are configurable, you just set the pins you want to use in the setting struct.\n\nThe makefile is copied from [esp_mqtt.](https://github.com/tuanpmt/esp_mqtt)\n\n###Building and installing:\n\nFirst you need to install the sdk and the easy way of doing that is to use [esp_open_sdk.](https://github.com/pfalcon/esp-open-sdk)\n\nYou can put that anywhere you like (/opt/local/esp-open-sdk, /esptools etc etc)\n\nThen you could create a small ```setenv.sh``` file, containing the location of your newly compiled sdk and other platform specific info;\n```\nexport SDK_BASE=/opt/local/esp-open-sdk/sdk\nexport PATH=${SDK_BASE}/../xtensa-lx106-elf/bin:${PATH}\nexport ESPPORT=/dev/ttyO0  \n```\n(or setup your IDE to do the same)\n\nYou will have to edit the ```include/user_config.h``` file to suit your WiFi and mqtt settings. Alternatively you can copy ```include/user_config.h``` into ```localinclude/user_config.h``` and git will not bother you about modified files.\n\nTo make a clean build, flash and connect to the esp console you just do this in a shell:\n```\nsource setenv.sh # This is only needed once per session\nmake clean \u0026\u0026 make test\n```\n\nYou won't be needing esptool, the makefile only uses esptool.py (provided by esp-open-sdk)\n\nI have tested this with sdk 1.5.2, v0.9.5 and v0.9.4 (linux \u0026 mac)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feadf%2Fesp_mqtt_lcd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feadf%2Fesp_mqtt_lcd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feadf%2Fesp_mqtt_lcd/lists"}