Skip to content
This repository was archived by the owner on Apr 21, 2024. It is now read-only.

Repository files navigation

MIT License


Logo

SIM App for Device

Send SMS from YOUR OWN and soon many more via API using our portal
See Sim App Panel



Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Possibilities
  5. Updates
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

The application was written and tested on Python 3.7. Its purpose is to communicate with the SIM800 overlay connected to your device on which you run it, and it also connects to our SIM App Controller via WebSocket, so you do not need to have a public IP address etc. After connecting this software to the controller and selecting the USB port to which the overlay is connected, you do not have to do anything else there. Everything else is done by the controller. In the following points, I will show you what you can use the controller for, but first we will deal with the installation.

The application is distinguished by the fact that through our portal, using the api, you can send text messages from your own sim card :)

(back to top)

Built With

  • RaspberryPI
  • Python37
  • Docker

(back to top)

Getting Started

For starters, you need an environment, preferably with linux.
You also need to buy a SIM800 overlay





I am testing the application on the add-on from this link above. I highly recommend her. It is also equipped with audio support, which is worth having, because I will be expanding the application in this direction (tone dialing).

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • If you are using docker (recommended)
    curl -fsSL https://get.docker.com -o get-docker.sh && sh get-docker.sh
  • If you want to install and use without docker
    apt install python3.7

Install via docker (recommended)

Installation is very simple, because the software shown here is published in the Docker Hub

  • Download .sh file

     curl -o sim-app.sh https://raw.githubusercontent.com/Let-s-Code-It/SIM-App-Device/master/sim-app.sh
    
    
  • Set permissions

    chmod +x sim-app.sh
  • Build and run

    ./sim-app.sh
    

(back to top)

Install via Python pip

The package is published on PyPi repository, so you just need to install it on python 3.7

  • Make sure python is installed.

    apt install python3.7
  • Install the python package via pip

    python3.7 -m pip install lci-sim-app-device
  • Now you can run the application.

    python3 -m lci-sim-app-device --dir="~/SIM-Data"

(back to top)

Usage

After launching the application, you will find it on the default port 8098. So go to http://localhost:8098

Now you should configure the application.

  1. Select Serial Port - select from the list the USB port to which the SIM shield is connected (which you should already have, or buy) product-screenshot-system-config If all goes well Serial Status should be green Connected like mine. In the future, if you change this port, restart the application.

  2. Now connect the device to the Portal, because after all everything will be done through it. To do this, you need to create an account here. Then go to the list of devices in the portal and click the "Add Device" button. Enter the key generated there in the form below. product-screenshot-controller-config After entering the key you should see Socket Connection status as Connected, pending adopt. You must then return to the controller where you will see your device listed and accept it.

(back to top)

Possibilities

What does the application offer or will offer

  • Connect with Controller
  • SMS
    • Send
    • Read
  • USSD Code
    • Send
    • Receive
  • Tone Dialing
  • Receive incomming calls
  • MMS
    • Send
    • Receive

(back to top)

Updates

When you go to the webserver of the installed application (port 8098), you will see the versions of the application used at the top. When an update is available, a message will also be visible next to the version. Do them right away, because the changes may be so big that the device may not work properly. Now we will move on to how to perform such updates.

  • If you are using docker

    curl -o sim-app.sh https://raw.githubusercontent.com/Let-s-Code-It/SIM-App-Device/master/sim-app.sh && ./sim-app.sh update
  • If you are not using docker

    python3 -m pip install lci-sim-app-device -U

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Let's Code It, Karol Sójka from Poland - kontakt@letscode.it

(back to top)

Acknowledgments

(back to top)

About

The software is intended for sim customers of the application to be installed and used with sim covers of the SIM800 type.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages