diff --git a/components/sim800l.rst b/components/sim800l.rst index d1ce18afb..3c01c990a 100644 --- a/components/sim800l.rst +++ b/components/sim800l.rst @@ -6,6 +6,9 @@ Sim800L Component :image: sim800l.jpg :keywords: SMS SIM800L GSM +Component/Hub +------------- + The ``SIM800L`` Component provides the ability to dial, send and receive SMS text messages. The device must be connected via a :doc:`UART bus ` supporting both receiving and transmitting line. 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" args: [ 'message.c_str()', 'sender.c_str()' ] + sensor: + - platform: sim800l + rssi: + name: "Sim800L RSSI" + + binary_sensor: + - platform: sim800l + registered: + name: "Sim800L Registered" + logger: baud_rate: 0 # disable uart logger on esp 8266 Configuration variables: ------------------------- - **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. - **on_sms_received** (*Optional*, :ref:`Automation `): An action to be 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 `. + + +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 `. + .. _sim800l-on_sms_received: ``on_sms_received`` Trigger