Skip to content

Latest commit

 

History

History
106 lines (86 loc) · 4.44 KB

README.md

File metadata and controls

106 lines (86 loc) · 4.44 KB
Raw

FemtoSIP ‒ A minimal SIP client

FemtoSIP is a minimal, incomplete, and utterly broken Python SIP implementation with the sole purpose of calling a SIP phone and immediately hanging up. This is quite handy for certain home automation tasks, such as signaling that someone is ringing the doorbell.

To call all phones in the house, FemtoSIP needs to be able to connect to a DECT/PSTN base-station that acts as a SIP server, for example the AVM FRITZ!Box common in Germany. The FRITZ!Box has a function where all connected phones can be called under a single internal phone number, such as **9.

Implementing the ring-on-door-bell task requires some additional hardware, such as a Raspberry Pi connected to the door gong via relay or opto-isolator; the repository contains an example script that demonstrates this particular use-case. The script has also been successfully used in conjunction with OpenHAB.

How to use

FemtoSIP consists of a single python file femtosip.py and only depends on Python 3.6 or newer. Python 3.6 should be present on most Linux installations and is available for other platforms as well. To use FemtoSIP, clone this Git repository and execute the femtosip.py program. Alternatively, instead of using Git, you can just download femtosip.py directly.

# Clone the program and go into the femtosip directory
git clone https://github.com/astoeckel/femtosip
cd femtosip

# Execute femtosip.py
python3 femtosip.py \
    --gateway 192.168.1.1 \       # IP address or hostname of the SIP server
    --user SIP_USER \             # SIP username
    --password SIP_PASSWORD \     # SIP password
    --call '**9' \                # Which phone number to call
    --delay 15.0 \                # How long to wait til hanging up
    --displayname MyCustomName    # Set the display name, if different from SIP login

If everything works, you should get an output which looks like this:

2018-01-01 11:41:42,749 request: INVITE sip:**9@192.168.1.1
2018-01-01 11:41:42,760 response: SIP/2.0 401 Unauthorized
2018-01-01 11:41:42,760 request: INVITE sip:**9@192.168.1.1
2018-01-01 11:41:42,772 response: SIP/2.0 100 Trying
2018-01-01 11:41:42,816 response: SIP/2.0 183 Session Progress
2018-01-01 11:41:57,816 request: CANCEL sip:**9@192.168.1.1
2018-01-01 11:41:57,828 response: SIP/2.0 487 Request Cancelled
2018-01-01 11:41:57,829 response: IP/2.0 200 OK

Alternatively, you can call femtosip from another Python script via

import femtosip
sip = femtosip.SIP(user, password, gateway, port, display_name)
sip.call(call, delay)

The example script rpi_sip_doorbell.py demonstrates basic usage of femtosip from another Python program and implements the aforementioned door-bell scenario. You can use this Python script as a systemd service with the provided rpi_sip_doorbell.service file. Please configure the script as desired by editing the service file. Then install the service by running the following commands from within the cloned Git repository

sudo mkdir -p /opt/rpi_sip_doorbell/
sudo install femtosip.py rpi_sip_doorbell.py /opt/rpi_sip_doorbell
sudo install rpi_sip_doorbell.service /etc/systemd/system
sudo systemctl enable rpi_sip_doorbell.service
sudo systemctl start rpi_sip_doorbell.service

Compatibility

This code was hacked together in a few hours and tested with the following SIP servers

  • AVM FRITZ!Box Fon WLAN 7390
  • AVM FRITZ!Box WLAN 7490
  • linphone 3.6.1 (libexosip2/3.6)

It is not guaranteed to work with any other server. Especially, by default, FemtoSIP uses a TCP connection for SIP, which is not supported by all endpoints. Use --protocol=udp if you run into connection problems.

License

FemtoSIP -- A minimal SIP client
Copyright (C) 2017-2023  Andreas Stöckel

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.