aboutsummaryrefslogtreecommitdiff
path: root/examples/sms-python/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/sms-python/README')
-rw-r--r--examples/sms-python/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/examples/sms-python/README b/examples/sms-python/README
new file mode 100644
index 00000000..50a1cc55
--- /dev/null
+++ b/examples/sms-python/README
@@ -0,0 +1,20 @@
+
+The sms-python program makes use of the 'libmm-glib' library through
+GObject Introspection to talk to ModemManager.
+
+The program will:
+ * Detect whether ModemManager is found in the bus
+ * Prepare SMS properties object with the provided Number and Text.
+ * Loop through each modem found in the system, and for each:
+ ** Create a SMS
+ ** Send the SMS
+
+The output will look like this:
+
+$ ./sms-python "+1234567890" "hello there, how are you?"
+/org/freedesktop/ModemManager1/Modem/0: sms sent
+
+Note that the program requires ModemManager and libmm-glib to be installed in
+the system and the introspection typelibs available in the standard paths.
+
+Have fun! \ No newline at end of file