Arduino  1.8.10
GSM3SMSService クラス

#include <GSM3SMSService.h>

GSM3SMSService の継承関係図
Stream Print

公開メンバ関数

 GSM3SMSService (bool synch=true)
 
size_t write (uint8_t c)
 
int beginSMS (const char *to)
 
int ready ()
 
int endSMS ()
 
int available ()
 
int remoteNumber (char *number, int nlength)
 
int read ()
 
int peek ()
 
void flush ()
 
- 基底クラス Stream に属する継承公開メンバ関数
 Stream ()
 
void setTimeout (unsigned long timeout)
 
unsigned long getTimeout (void)
 
bool find (char *target)
 
bool find (uint8_t *target)
 
bool find (char *target, size_t length)
 
bool find (uint8_t *target, size_t length)
 
bool find (char target)
 
bool findUntil (char *target, char *terminator)
 
bool findUntil (uint8_t *target, char *terminator)
 
bool findUntil (char *target, size_t targetLen, char *terminate, size_t termLen)
 
bool findUntil (uint8_t *target, size_t targetLen, char *terminate, size_t termLen)
 
long parseInt (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
 
float parseFloat (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
 
size_t readBytes (char *buffer, size_t length)
 
size_t readBytes (uint8_t *buffer, size_t length)
 
size_t readBytesUntil (char terminator, char *buffer, size_t length)
 
size_t readBytesUntil (char terminator, uint8_t *buffer, size_t length)
 
String readString ()
 
String readStringUntil (char terminator)
 
- 基底クラス Print に属する継承公開メンバ関数
 Print ()
 
int getWriteError ()
 
void clearWriteError ()
 
size_t write (const char *str)
 
virtual size_t write (const uint8_t *buffer, size_t size)
 
size_t write (const char *buffer, size_t size)
 
virtual int availableForWrite ()
 
size_t print (const __FlashStringHelper *)
 
size_t print (const String &)
 
size_t print (const char[])
 
size_t print (char)
 
size_t print (unsigned char, int=DEC)
 
size_t print (int, int=DEC)
 
size_t print (unsigned int, int=DEC)
 
size_t print (long, int=DEC)
 
size_t print (unsigned long, int=DEC)
 
size_t print (double, int=2)
 
size_t print (const Printable &)
 
size_t println (const __FlashStringHelper *)
 
size_t println (const String &s)
 
size_t println (const char[])
 
size_t println (char)
 
size_t println (unsigned char, int=DEC)
 
size_t println (int, int=DEC)
 
size_t println (unsigned int, int=DEC)
 
size_t println (long, int=DEC)
 
size_t println (unsigned long, int=DEC)
 
size_t println (double, int=2)
 
size_t println (const Printable &)
 
size_t println (void)
 

その他の継承メンバ

- 基底クラス Stream に属する継承限定公開メンバ関数
int timedRead ()
 
int timedPeek ()
 
int peekNextDigit (LookaheadMode lookahead, bool detectDecimal)
 
long parseInt (char ignore)
 
float parseFloat (char ignore)
 
int findMulti (struct MultiTarget *targets, int tCount)
 
- 基底クラス Print に属する継承限定公開メンバ関数
void setWriteError (int err=1)
 
- 基底クラス Stream に属する継承限定公開変数類
unsigned long _timeout
 
unsigned long _startMillis
 

詳解

GSM3SMSService.h40 行目に定義があります。

構築子と解体子

◆ GSM3SMSService()

GSM3SMSService::GSM3SMSService ( bool  synch = true)

Constructor

引数
synchDetermines sync mode

GSM3SMSService.cpp46 行目に定義があります。

47 {
48  if(synch)
49  flags |= GSM3SMSSERVICE_SYNCH;
50 }
#define GSM3SMSSERVICE_SYNCH

関数詳解

◆ available()

int GSM3SMSService::available ( void  )
virtual

Check if SMS available and prepare it to be read

戻り値
number of bytes in a received SMS

Streamを実装しています。

GSM3SMSService.cpp82 行目に定義があります。

83 {
84  return waitForAnswerIfNeeded(theGSM3SMSProvider->availableSMS());
85 };
GSM3MobileSMSProvider * theGSM3SMSProvider

◆ beginSMS()

int GSM3SMSService::beginSMS ( const char *  to)

Begin a SMS to send it

引数
toDestination
戻り値
error command if it exists

GSM3SMSService.cpp60 行目に定義があります。

61 {
62  return waitForAnswerIfNeeded(theGSM3SMSProvider->beginSMS(number));
63 };
GSM3MobileSMSProvider * theGSM3SMSProvider
virtual int beginSMS(const char *to)

◆ endSMS()

int GSM3SMSService::endSMS ( )

End SMS

戻り値
error command if it exists

GSM3SMSService.cpp65 行目に定義があります。

66 {
67  return waitForAnswerIfNeeded(theGSM3SMSProvider->endSMS());
68 };
GSM3MobileSMSProvider * theGSM3SMSProvider

◆ flush()

void GSM3SMSService::flush ( void  )
virtual

Delete the SMS from Modem memory and proccess answer

Printを再実装しています。

GSM3SMSService.cpp76 行目に定義があります。

77 {
79  waitForAnswerIfNeeded(1);
80 };
GSM3MobileSMSProvider * theGSM3SMSProvider

◆ peek()

int GSM3SMSService::peek ( void  )
virtual

Read a byte but do not advance the buffer header (circular buffer)

戻り値
byte

Streamを実装しています。

GSM3SMSService.cpp97 行目に定義があります。

98 {
99  return theGSM3SMSProvider->peekSMS();
100 };
GSM3MobileSMSProvider * theGSM3SMSProvider

◆ read()

int GSM3SMSService::read ( void  )
virtual

Read one char for SMS buffer (advance circular buffer)

戻り値
byte

Streamを実装しています。

GSM3SMSService.cpp93 行目に定義があります。

94 {
95  return theGSM3SMSProvider->readSMS();
96 };
GSM3MobileSMSProvider * theGSM3SMSProvider

◆ ready()

int GSM3SMSService::ready ( )

Get last command status

戻り値
returns 0 if last command is still executing, 1 success, >1 error

GSM3SMSService.cpp55 行目に定義があります。

56 {
57  return theGSM3SMSProvider->ready();
58 }
virtual int ready()=0
GSM3MobileSMSProvider * theGSM3SMSProvider

◆ remoteNumber()

int GSM3SMSService::remoteNumber ( char *  number,
int  nlength 
)

Read sender number phone

引数
numberBuffer for save number phone
nlengthBuffer length
戻り値
1 success, >1 error

GSM3SMSService.cpp87 行目に定義があります。

88 {
89  return theGSM3SMSProvider->remoteSMSNumber(number, nlength);
90 
91 }
virtual int remoteSMSNumber(char *number, int nlength)
GSM3MobileSMSProvider * theGSM3SMSProvider

◆ write()

size_t GSM3SMSService::write ( uint8_t  c)
virtual

Write a character in SMS message

引数
cCharacter
戻り値
size

Printを実装しています。

GSM3SMSService.cpp70 行目に定義があります。

71 {
73  return 1;
74 }
GSM3MobileSMSProvider * theGSM3SMSProvider
virtual void writeSMS(const char c)

このクラス詳解は次のファイルから抽出されました: