GettingStarted.rst

Getting started

Installation

Using pip:

sudo -H pip install git+git://github.com/oozie/pyhumod.git

Alternatively download the source, extract and install system-wide using sudo. The following should work for most Unix derivatives:

wget https://github.com/oozie/pyhumod/archive/master.zip
unzip master.zip
cd download
sudo python setup.py install

Please note this package requires pySerial and detect module uses dbus-python to talk to HAL. pySerial is a required dependency, dbus-python can be installed if you want to take advantage of the humod.detect module.

Pyserial 3.x from https://github.com/pyserial/pyserial has a native Python 3 support. For the Pyserial 2.7 you need to install it using "python3 setup.py install", where it invokes 2to3.py to convert Pyserial code.

Usage guide

Once installed, you can write your own scripts or this package from an interpreter. In both cases you need to import humod first and then instantiate a Modem() (see OS specific intro below).

Writing your own scripts

An example script could look as follows:

#!/usr/bin/env python

import humod
m = humod.Modem()
model = m.show_model()
print('You are using %s 3G modem.' % model)

Using a Python interpreter

Most of the examples here are run from the standard python interpreter, but you are welcome to use iPython.

$ python3
...
>>> import humod
>>> mod = humod.Modem('/dev/ttyUSB0', '/dev/ttyUSB1')
>>> mod.show_model()
>>> 'E270'

Instantiating a Modem()

The key task that must be accomplished every time you want to talk to the modem is to instantiate a Modem() class. In order for instatiation to suceed you must know where the required data and control ports are. For most Linux users the data port will be located in /dev/ttyUSB0 and the control port in /dev/ttyUSB1 and these are the values that the Modem() class defaults to. Custom values for data and control ports can be passed to the Modem() class as the first and the second argument respectively. In other words, the statement:

m = humod.Modem()

is equal to:

m = humod.Modem('/dev/ttyUSB0', '/dev/ttyUSB1')

but some MacOS X users may want to execute the following:

m = humod.Modem('/dev/cu.HUAWEIMobile-Modem', '/dev/cu.HUAWEIMobile-Pcui')
# or
m = humod.Modem('/dev/tty.HUAWEIMobile-Modem', '/dev/tty.HUAWEIMobile-Pcui')

If unsure, check

ls -l /dev/

and see what changes when you plug and unplug your USB modem.

Next: You can now try to connect to or disconnect from the 3G network.