mobizt / ESP-Line-Notify

The ESP8266 and ESP32 Arduino library for sending the message to Line Notify

LINE Notify Arduino Library for ESP8266 and ESP32

This Arduino library allows ESP8266 and ESP32 to send LINE Notify message, sticker and images.

The library supported Ethernet in ESP32 using LAN8720, TLK110 and IP101 Ethernet modules and ESP8266 using ENC28J60, W5100 and W5500 Ethernet modules

This library allows you to use external Arduino Clients network interfaces e.g. WiFiClient, EthernetClient and GSMClient.

To use external Client, see the ExternalClient examples.

The flash and SD filesystems supports depend on the devices and third party filesystems libraries installed.

Copyright (c) 2022 K. Suwatchai (Mobizt).

Tested Devices

This following devices were tested and work well.

• Sparkfun ESP32 Thing
• NodeMCU-32
• WEMOS LOLIN32
• TTGO T8 V1.8
• M5Stack ESP32
• NodeMCU ESP8266
• Wemos D1 Mini (ESP8266)
• Arduino MKR WiFi 1010
• LAN8720 Ethernet PHY
• ENC28J60 SPI Ethernet module

Features

• Support sending text, sticker and images from flash and SD memory.

• Show upload progress via callback function.

• Support SRAM/PSRAM in ESP8266 and ESP32.

• Flash and SD File systems can be configured to use LittleFS, FFat and SD_MMC

Installation

Click on Clone or download dropdown at the top of repository, select Download ZIP and save file on your computer.

From Arduino IDE, goto menu Sketch -> Include Library -> Add .ZIP Library... and choose ESP-Line-Notify-main.zip that previously downloaded.

Go to menu Files -> Examples -> ESP-Line-Notify-main and choose one from examples

Use SRAM/PSRAM in ESP32 and ESP8266

To enable PSRAM in ESP32 module with on-board PSRAM chip, in Arduino IDE

In PlatformIO in VSCode IDE, add the following build_flags in your project's platformio.ini file

build_flags = -DBOARD_HAS_PSRAM -mfix-esp32-psram-cache-issue

*When config the IDE or add the build flags to use PSRAM in the ESP32 dev boards that do not have on-board PSRAM chip, your device will be crashed (reset).

In ESP8266, to use external Heap from 1 Mbit SRAM 23LC1024, choose the MMU option 5, 128K External 23LC1024.

To use external Heap from PSRAM, choose the MMU option 6, 1M External 64 MBit PSRAM.

In PlatformIO, PIO_FRAMEWORK_ARDUINO_MMU_EXTERNAL_128K or PIO_FRAMEWORK_ARDUINO_MMU_EXTERNAL_1024K build flag should be assigned in platformio.ini.

[env:d1_mini]
platform = espressif8266
build_flags = -D PIO_FRAMEWORK_ARDUINO_MMU_EXTERNAL_128K
board = d1_mini
framework = arduino
monitor_speed = 115200

The connection between SRAM/PSRAM and ESP8266

23LC1024/ESP-PSRAM64                ESP8266

CS (Pin 1)                          GPIO15
SCK (Pin 6)                         GPIO14
MOSI (Pin 5)                        GPIO13
MISO (Pin 2)                        GPIO12
/HOLD (Pin 7 on 23LC1024 only)      3V3
Vcc (Pin 8)                         3V3
Vcc (Pin 4)                         GND

To use SRAM/PSRAM in this library, the macro in file FS_Config.h was set.

#define ESP_LINE_NOTIFY_USE_PSRAM

Usages

  #include <ESP_Line_Notify.h>

  /* Define the LineNotifyClient object */
  LineNotifyClient line;


  line.token = "Your Line Notify Access Token";
  line.message = "Hello world";

  //The image to send
  line.image.file.path = "/test.jpg";
  line.image.file.storage_type = LineNotify_Storage_Type_Flash; //or LineNotify_Storage_Type_SD
  line.image.file.name = "test.jpg";

  LineNotiFySendingResult result = lineNotify.send(line);

  if (result.status == LineNotify_Sending_Success)
  {
    Serial.printf("Status: %s\n", "success");
    Serial.printf("Text limit: %d\n", result.quota.text.limit);
    Serial.printf("Text remaining: %d\n", result.quota.text.remaining);
    Serial.printf("Image limit: %d\n", result.quota.image.limit);
    Serial.printf("Image remaining: %d\n", result.quota.image.remaining);
    Serial.printf("Reset: %d\n", result.quota.reset);
  }
  else if (result.status == LineNotify_Sending_Error)
  {
    Serial.printf("Status: %s\n", "error");
    Serial.printf("error code: %d\n", result.error.code);
    Serial.printf("error msg: %s\n", result.error.message.c_str());
  }

See full examples for complete usages.

All Supported Functions

Send the Line Notify message.

param client The LineNotifyClient data which contains TCP client with message data

return LineNotiFySendingResult type data to get the sending result.

LineNotiFySendingResult send(LineNotifyClient &client);

SD card config with GPIO pins.

param ss SPI Chip/Slave Select pin.

param sck SPI Clock pin.

param miso SPI MISO pin.

param mosi SPI MOSI pin.

return Boolean type status indicates the success of the operation.

bool sdBegin( int8_t ss = -1, int8_t sck = -1, int8_t miso = -1, int8_t mosi = -1);

SD card config with SD FS configurations (ESP8266 only).

param sdFSConfig The pointer to SDFSConfig object (ESP8266 only).

return Boolean type status indicates the success of the operation.

bool sdBegin(SDFSConfig *sdFSConfig);

SD card config with chip select and SPI configuration (ESP32 only).

param ss SPI Chip/Slave Select pin.

param spiConfig The pointer to SPIClass object for SPI configuartion (ESP32 only).

return Boolean type status indicates the success of the operation.

bool sdBegin(int8_t ss, SPIClass *spiConfig = nullptr);

SD card config with SdFat SPI and pins configurations (ESP32 with SdFat included only).

param sdFatSPIConfig The pointer to SdSpiConfig object for SdFat SPI configuration.

param ss SPI Chip/Slave Select pin.

param sck SPI Clock pin.

param miso SPI MISO pin.

param mosi SPI MOSI pin.

return Boolean type status indicates the success of the operation.

bool sdBegin(SdSpiConfig *sdFatSPIConfig, int8_t ss = -1, int8_t sck = -1, int8_t miso = -1, int8_t mosi = -1);

Initialize the SD_MMC card (ESP32 only).

param mountpoint The mounting point.

param mode1bit Allow 1 bit data line (SPI mode).

param format_if_mount_failed Format SD_MMC card if mount failed.

return Boolean type status indicates the success of the operation.

bool sdMMCBegin(<string> mountpoint = "/sdcard", bool mode1bit = false, bool format_if_mount_failed = false);

License

The MIT License (MIT)

Copyright (c) 2022 K. Suwatchai (Mobizt)

Permission is hereby granted, free of charge, to any person returning a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.