:pserver:anonymous@intra.tektonica.com:/opt/cvs - gsmperl - Fri Dec 21 07:37 CET...
[gsmperl.git] / GSM / README
1                                                                  GSM::SMS
2                                          Perl Modules For Smart Messaging
3
4
5
6 INTRODUCTION
7
8 This set of modules allows you to send and receive SMS messages. Besides text 
9 messages you can also use Smart Messages, also known as ringing tones, 
10 groupgraphics, vcards etc...
11
12 Out of the box, it comes with a serial transport and a transport for Novelsoft,
13 a HTTP based SMSC (http://www.sms-wap.com ). To use the serial transport you 
14 will need a GSM modem, like the wavecom WMOD2B ( http://www.wavecom.com ). If 
15 you want to receive SMS messages, the serial solution is the only one for the 
16 moment. You even can have some success with running the gnokii project to power
17 a Nokia 6110 or something, but I have not tested this. Other options are the 
18 M20 from Siemens and the A1 or A2 from Falcom.
19
20 The module that is the most interesting for you is probably the GSM::SMS::NBS 
21 module, as this is the high level interface you are supposed to use. Please 
22 look at the examples to see how you use the library.
23
24 For the moment the package comes with support for the following Smart Messaging 
25 formats:
26         
27         * ring tones (RTTTL)
28         * Caller Line Identification logos
29         * Operator logos
30         * VCard
31         * OTA Configuration for WAP phones
32
33 NEW IN THIS RELEASE
34         Look in the 'Changes' file for a complete review and credits.
35
36         * GSM::SMS::NBS::sendOperatorLogo_from{file,b64} now works.
37         * GSM::SMS::Support::RTTTL2MIDI converts rtttl strings to midi.
38         * Serial transport wait correctly for the modem to come up when
39           reading SIM card information (phonebook, ...).
40         * GSM::SMS::NBS returns success and failure correctly     
41         * XmlRpc Transport for remote node functionality.
42           ( Look at the iSMS package for example, http://www.tektonica.com )
43         * Faster SMS delete on Serial transport
44         * Supports more GSM modems ( Siemens ) by use of extra
45           config parameter ( memorylimit ).
46
47 PREREQUISITES
48
49 Following packages are mandatory
50
51         * Data::Dumper
52         * MIME::Base64
53         * Image::Magick
54         * LWP
55         * Device::SerialPort
56
57
58
59 INSTALL
60
61 I *should* be a simple:
62         perl Makefile.PL
63         make
64         make install
65
66
67
68 CONFIGURATION
69
70 This is important, because the transports need to be configured.
71 The best you can do is look in the examples for the file transport.cfg.
72 This file contains the necessary settings for the transports and are
73 (clearly) documented. As time permits I will be expanding the documentation.
74
75 SERIAL TRANSPORT
76
77 A note about the serial transport. To use this you need to have 
78 Device::SerialPort installed. For the moment this also means that this part is 
79 not Win32 compliant, as another module ( Win32::SerialPort ) is used on the 
80 other system. Expect an update that also works on window systems.
81
82 A problem that can arise when using the serial tarnsport is the setting of the 
83 service center address. If this happens, or if you want to set this manually, 
84 use the following command(s) in your favourite comms program. I use minicom ...
85
86         >minicom -s
87         AT+CPIN?
88                 Check for pincode
89         AT+CPIN="nnnn"
90                 Set pincode. Important ... only 3 tries!!!
91         AT+CSCA?
92                 Check for service center address
93         AT+CSCA="+32475161616"
94                 Set service center address. ( This one is for proximus belgium ).
95
96 EXAMPLES
97
98 Look in the examples directory, this should get you started.
99 The most complex one is the smartmessagingserver, allowing you to request a
100 rttl or groupgraphic by sending an sms message. The slashdot example allows
101 you to receive the latest slashdot headlines in a SMS message. The ideas are
102 ofcourse endless. I've build an application on top of these modules that
103 expose the send functions in an XMLRPC way, thus creating a SMS webservice.
104
105
106
107 BUGS
108
109 Probably a lot. I hope I get a lot of feedback so we can figure the bugs out 
110 and start fixing them!
111
112
113 AUTHOR
114
115 Johan Van den Brande
116 johan@vandenbrande.com
117
118
119
120 COPYRIGHT
121
122 Copyright (c) 1999-2001 Johan Van den Brande
123 All rights reserved.
124
125 This program is free software; you can redistribute it and/or modify it
126 under the same terms as Perl itself. 
127
128 DISCLAIMER
129
130 I take no responsibility for anything that can go wrong or can be done wrong 
131 with this piece of software.
132
133 Please look at the file DISCLAIMER.