Update README.md

This commit is contained in:
Deunix@e-educ.fr
2021-04-15 15:48:55 +02:00
committed by GitHub
parent 7c91e9d4f2
commit 4b2688f1ab
+12 -14
View File
@@ -3,23 +3,20 @@ SMS and notification gateway using Android smartphone
#### Goal: #### Goal:
Make any laptop with an Internet connection a SMS gateway Send and receive SMS or notification to a smartphone destination from any desktop using a web interface or other client.
Send SMS from his desktop using a web interface or other.
Receive SMS on his desk in order to use the content.
#### Method used #### Method used
- SMS sending ##### SMS emission
- SMS are created on one machine (1 or more) on the network. - SMS or notifications are created on one machine (1 or more) on the net.
- They are then published to a public or private MQTT server - Messages are then published to a public or private MQTT server
- The messages are received on an MQTT client installed on the laptop (1 or more). - Smsquitto MQTT client installed on the smartphone gateway (1 or more), then receive and send these messages to recipients.
- The messages are then sent to the recipients.
#### SMS reception #### SMS reception
- The SMS are received on the smartphone and published to the MQTT server - SMS received on the smartphone gateway are published to a MQTT server.
- The messages are received on a MQTT client installed on the subscribed machine (1 or more) - A MQTT client installed on a machine (1 or more) that have subscribed to a valid topic receive these messages
#### Non-exhaustive use #### Non-exhaustive use
@@ -44,33 +41,34 @@ Receive SMS on his desk in order to use the content.
https://github.com/termux/termux-app https://github.com/termux/termux-app
#### Installation of termux #### Termux installation
- Termux application obtained by F-Droid: - Termux application obtained by F-Droid:
- https://www.f-droid.org/fr/ - https://www.f-droid.org/fr/
- Or by google store: - Or by google store:
- https://play.google.com/ - https://play.google.com/
> IMPORTANT: We will choose either one or the other. > IMPORTANT: You must choose either one or the other repository.
- Install - Install
- Termux - Termux
- Termux: API - Termux: API
- Termux: Widget - Termux: Widget
#### Installing the mqtt client: #### MQTT client installing:
The following python packages will be installed: The following python packages will be installed:
- termux-sms-gateway - termux-sms-gateway
- paho-mqtt - paho-mqtt
- supervisor
- rsa >> https://stuvel.eu/python-rsa-doc/ - rsa >> https://stuvel.eu/python-rsa-doc/
### Installation procedure ### Installation procedure
After installing termux on the laptop, launch Termux After installing termux on the laptop, launch Termux
- Copy and paste the following command in the terminal - Copy and paste the following command in the termux terminal
export PACKAGE="TermuxSmsGateway"&&export VERSION="1.0"&&mkdir -p $HOME/.termux/tasks&& export PACKAGE="TermuxSmsGateway"&&export VERSION="1.0"&&mkdir -p $HOME/.termux/tasks&&
apt install termux-api git -y&&rm -rf termux-sms-gateway&& apt install termux-api git -y&&rm -rf termux-sms-gateway&&