Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-26 17:27:47 +01:00
Code Issues Projects Releases Wiki Activity

add sim800l diags (#1864)

Browse Source
This commit is contained in:
Guillermo Ruffino 2022-02-15 01:01:55 -03:00 committed by GitHub
parent 7a4a703e2e
commit 249d9c44fb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
components/sim800l.rst
View File

@ -6,6 +6,9 @@ Sim800L Component
:image: sim800l.jpg :image: sim800l.jpg
:keywords: SMS SIM800L GSM :keywords: SMS SIM800L GSM
Component/Hub
-------------
The ``SIM800L`` Component provides the ability to dial, send and receive SMS text messages. The device must be The ``SIM800L`` Component provides the ability to dial, send and receive SMS text messages. The device must be
connected via a :doc:`UART bus </components/uart>` supporting both receiving and transmitting line. connected via a :doc:`UART bus </components/uart>` supporting both receiving and transmitting line.
The UART bus must be configured at the same speed of the module which is by default 9600bps. The UART bus must be configured at the same speed of the module which is by default 9600bps.
@ -40,17 +43,49 @@ The required connection wires are ``+VCC``, ``GND``, ``RX`` and ``TX``.
format: "Received '%s' from %s" format: "Received '%s' from %s"
args: [ 'message.c_str()', 'sender.c_str()' ] args: [ 'message.c_str()', 'sender.c_str()' ]
sensor:
- platform: sim800l
rssi:
name: "Sim800L RSSI"
binary_sensor:
- platform: sim800l
registered:
name: "Sim800L Registered"
logger: logger:
baud_rate: 0 # disable uart logger on esp 8266 baud_rate: 0 # disable uart logger on esp 8266
Configuration variables: Configuration variables:
------------------------
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the UART hub. - **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the UART hub.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **on_sms_received** (*Optional*, :ref:`Automation <automation>`): An action to be - **on_sms_received** (*Optional*, :ref:`Automation <automation>`): An action to be
performed when an SMS is received. See :ref:`sim800l-on_sms_received`. performed when an SMS is received. See :ref:`sim800l-on_sms_received`.
Sensor
------
Configuration variables:
- **rssi** (*Optional*): The informed Received signal strength indication (RSSI) in dBm.
- **name** (**Required**, string): The name for the rssi sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
Binary sensor
-------------
Configuration variables:
- **registered** (*Optional*): Indicates if the SIM800L has successfully registered in the cellular network.
- **name** (**Required**, string): The name for the registered binary sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
.. _sim800l-on_sms_received: .. _sim800l-on_sms_received:
``on_sms_received`` Trigger ``on_sms_received`` Trigger