Skip to content

Commit

Permalink
removed Instructions to call loop()
Browse files Browse the repository at this point in the history
  • Loading branch information
simone1999 authored Jul 25, 2019
1 parent 87339bb commit 4cadda4
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Self-assembling mesh network built around the MQTT protocol for the ESP8266 with

## Overview
This code provides a library that can build a mesh network between ESP8266 devices that will allow all nodes to communicate
with an MQTT broker. At least one node must be able to see a wiFi router, and there must me a host on the WiFi network running
with an MQTT broker. At least one node must be able to see a wiFi router, and there must be a host on the WiFi network running
the MQTT broker.
Nodes cannot (generally) communicate between themselves, but instead forward all messages through the broker.
Each node will expose a hidden AP which can be connected to from any other node on the network. Note: hiding the AP does not provide
Expand Down Expand Up @@ -42,7 +42,7 @@ PlatformIO is strongly recommended, and installation instructions can be found [

**NOTE:** Enabling SSL will add ~70kB to the firmware size, and may make it impossible to use OTA updates depending on firmware and flash size.

If OTA support is desired, the esp8266 module must have at least 1M or Flash (configured as >=784k ROM). The OTA image is stored
If OTA support is desired, the esp8266 module must have at least 1M of Flash (configured as >=784k ROM). The OTA image is stored
between the end of the firmware image and the beginning of the filesystem (i.e. not in the filesystem itself) or the end of flash if
no filesystem is present. Thus, ithe maximum firmware size is ~ 1/2 the available Flash.

Expand Down Expand Up @@ -114,7 +114,7 @@ setMeshSSL(cert, cert_len, key, key_len, fingerprint)
- `uint8_t *fingerprint`: Certificate fingerprint (SHA1 of certificate)

### Interacting with the mesh
Besides the constructor, the code must call the `begin()` method during setup, and the `loop()` method in the main loop
Besides the constructor, the code must call the `begin()` method during setup.

If messages need to be received by the node, execute the `callback()` function during setup with a function pointer
(prototype: `void callback(const char *topic, const char *payload)`)
Expand All @@ -129,7 +129,7 @@ function will send messages with the `in_topic` prefix and will be relayed back

- `const char *topic`: the message topic (will be appended to the topic-prefix)
- `const char *payload`: The message to send (must be less than 1152 bytes in length)
- `enum MSG_TYPE msgCmd`: The MQTT Retail/QoS partameters (optional). Must be one of: `MSG_TYPE_NONE`,
- `enum MSG_TYPE msgCmd`: The MQTT Retail/QoS parameters (optional). Must be one of: `MSG_TYPE_NONE`,
`MSG_TYPE_QOS_0`, `MSG_TYPE_QOS_1`, `MSG_TYPE_QOS_2`, `MSG_TYPE_RETAIN_QOS_0`, MSG_TYPE_RETAIN_QOS_1`,
`MSG_TYPE_RETAIN_QOS_2`. Default: `MSG_TYPE_NONE`

Expand Down

0 comments on commit 4cadda4

Please sign in to comment.