Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renamed example file to fit PlatformIO, added detailed quickstart #9

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

ibaranov-cp
Copy link

Open to comments, change requests, etc.
Should be on 0.8.4

@PhracturedBlue
Copy link
Owner

I'm not really keen to rename credentials.h.example. There are 2 reasons:

  1. It makes it more difficult for me to maintain the code, as I need to keep the template version as well as the version I actually use for day-to-day testing and make sure I switch between them before and after each commit.

  2. You can't use the file as is regardless

Copy link
Owner

@PhracturedBlue PhracturedBlue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend creating a README.Windows that has your specific setup instructions, and keep the primary README.md platform neutral.

This describes one fast and easy way to get started, though there are other options.

You will require:
- A wirless router, with a dedicated secured (WPA2, AES) 2.4Ghz network, set to control channel 1 (2.412 Ghz), auto 20/40Mhz mode
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Channel 1 should no longer be necessary, since I've made the default be to use the staging tree

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still needed it seems like, tried it out today. Not a bad comment to have regardless to reduce potential issues.

1b) Install the ESP8266MQTTMesh Library. PlatfromIO Home -> Libraries -> Search -> ```ESP8266MQTTMesh``` -> Install\
This should automatically install all necessary pre-requisites.
2) Install the MQTT Broker: Mosquitto and all pre-requisites https://mosquitto.org/download/
3) Install the MQTT UI/Monitor: MQTT.fx http://www.mqttfx.org/
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that installing MQTT is beyond the scope of what I'd expect in a tutorial...
MQTT.fx is certainly not necessary

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would help debug issues

4) Install Python, and paho-mqtt. In Windows: ```python -m pip install paho-mqtt``` This is needed for OTA updates.
5) In Windows, add outgoing and incoming firewall rules to allow ports 1883 and optionally 1884
6) Start the Mosquitto Broker. In Windows, start a administrator command prompt, navigate to C:\Program Files (x86)\mosquitto and type in ```net start mosquitto```
7) Start MQTT.fx and click connect. Button on the right should turn green. Go to the subscribe tab, and click scan under topics collector
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, I think describing the setup on MQTT is unnecessary. Also, since I program exclusively in Linux, I cannot support any of these Windowsisms. This means I won't be able to help resolve issues related to windows setup.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of these programs have identical Linux versions, I happen to use both

9) Start the Serial Monitor in PlatformIO to see debug messages as needed.
10) You should now see Topics appearing in MQTT.fx window from step 7). Clicking on a topic should show data
![](http://i.imgur.com/ucylCqR.png)
11) Publishing data to a node can also be done through the UI by selecting the esp8266-in/* topic that matches the esp8266-out/* topic seen in the subscribe window.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And again with the MQTT.fx

@austonpramodh
Copy link

This is actually helpful...

@austonpramodh
Copy link

BUt I still dont understand how to use send_ota.py or how to start with it...please help

@shajek
Copy link
Contributor

shajek commented May 3, 2018

Something like this
python.exe send_ota.py --bin firmware.bin --broker your.broker.eu --user test --password test123 --topic esp8266- --node 123ef12

alexmogavero pushed a commit to alexmogavero/ESP8266MQTTMesh that referenced this pull request Jul 23, 2023
sending Ping Answer on InTopic exept on out Topic
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants