Module mobile

Module implementing the Ceylan-Mobile services.

Description

Module implementing the Ceylan-Mobile services.

Operates through a Seaplus-based interface to the Gammu backend library.

See Ceylan-Seaplus at http://seaplus.esperide.org.

Data Types

backend_type()

backend_type() = gammu

backend_version()

backend_version() = basic_utils:version()

For example {1,40,1}.

bin_mobile_number()

bin_mobile_number() = bin_string()

The mobile number associated to a device, as a binary (e.g. <<"+1234567890">>).

bin_sms_message()

bin_sms_message() = bin_string()

bin_string()

bin_string() = text_utils:bin_string()

count()

count() = basic_utils:count()

date_text()

date_text() = bin_string()

device_name()

device_name() = bin_string()

encoding()

encoding() = unicode_uncompressed | unicode_compressed | gsm_uncompressed | gsm_compressed | eight_bit

error_rate()

error_rate() = integer_percent()

For example -1% (!) or 0%.

hardware_info()

hardware_info() = bin_string()

For example <<"FOO DUMMY BAR">>, <<"Gammu error: Function not supported by phone.">>.

imei()

imei() = bin_string()

International Mobile Equipment Identity code.

For example <<"154483225355085">>.

imsi_code()

imsi_code() = bin_string()

International Mobile Subscriber Identity code. For example <<"208150030213526">>.

integer_percent()

integer_percent() = math_utils:integer_percent()

manufacturer_name()

manufacturer_name() = bin_string()

mobile_number()

mobile_number() = ustring()

The mobile number associated to a device (e.g. "+1234567890").

model_name()

model_name() = bin_string()

received_sms()

received_sms() = #received_sms{sender_number = bin_mobile_number(), encoding = encoding(), text = bin_sms_message(), message_reference = sms_tpmr(), timestamp = sms_timestamp()}

Describes a received SMS.

revision_number()

revision_number() = float()

revision_text()

revision_text() = bin_string()

seaplus_option()

seaplus_option() = any()

signal_strength()

signal_strength() = integer_percent()

In dBm. For example -51 dBm or 42 dBm.

signal_strength_percent()

signal_strength_percent() = integer_percent()

In dBm. For example 100% or 42%.

sms_class()

sms_class() = non_neg_integer()

Most SMS are of class 1 (the default, should no class by specified).

See also http://www.ozekisms.com/index.php?owpn=544.

sms_message()

sms_message() = ustring()

User-specified SMS message.

sms_sending_report()

sms_sending_report() = {sms_sending_status(), sms_tpmr()}

Returned by a sending.

sms_sending_status()

sms_sending_status() = success | failure

Describes the status of a SMS sending.

sms_timestamp()

sms_timestamp() = bin_string()

sms_tpmr()

sms_tpmr() = count()

Message reference, as generated by the GSM network.

three_digit_version()

three_digit_version() = basic_utils:three_digit_version()

ustring()

ustring() = text_utils:ustring()

Function Index

activate_seaplus/1
get_mobile_version/0Returns the version of the Mobile library being used.
get_mobile_version_string/0Returns the version of the Mobile library being used, as a string.
received_sms_to_string/1Returns a textual description of the specified received SMS.
restart/0

Function Details

activate_seaplus/1

activate_seaplus(Options::[seaplus_option()]) -> void()

get_mobile_version/0

get_mobile_version() -> three_digit_version()

Returns the version of the Mobile library being used.

get_mobile_version_string/0

get_mobile_version_string() -> ustring()

Returns the version of the Mobile library being used, as a string.

received_sms_to_string/1

received_sms_to_string(Received_sms) -> any()

Returns a textual description of the specified received SMS.

restart/0

restart() -> void()


Generated by EDoc