Arduino  1.8.9
GSM3ShieldV1DirectModemProvider クラス

#include <GSM3ShieldV1DirectModemProvider.h>

GSM3ShieldV1DirectModemProvider の継承関係図
GSM3ShieldV1BaseProvider Stream Print

公開メンバ関数

 GSM3ShieldV1DirectModemProvider (bool trace=false)
 
void begin ()
 
void restartModem ()
 
void connect ()
 
void disconnect ()
 
size_t write (uint8_t c)
 
int available ()
 
int read ()
 
int peek ()
 
void flush ()
 
void manageResponse (byte from, byte to)
 
bool recognizeUnsolicitedEvent (byte from)
 
String writeModemCommand (String command, int delay)
 
- 基底クラス GSM3ShieldV1BaseProvider に属する継承公開メンバ関数
int ready ()
 
void prepareAuxLocate (PGM_P str, char auxLocate[])
 
- 基底クラス 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
 

詳解

GSM3ShieldV1DirectModemProvider.h44 行目に定義があります。

構築子と解体子

◆ GSM3ShieldV1DirectModemProvider()

GSM3ShieldV1DirectModemProvider::GSM3ShieldV1DirectModemProvider ( bool  trace = false)

Constructor

引数
traceif true, dumps all AT dialogue to Serial

GSM3ShieldV1DirectModemProvider.cpp42 行目に定義があります。

43 {
44  trace=t;
45 };

関数詳解

◆ available()

int GSM3ShieldV1DirectModemProvider::available ( void  )
virtual

Check for incoming bytes in buffer

戻り値

Streamを実装しています。

GSM3ShieldV1DirectModemProvider.cpp81 行目に定義があります。

82 {
83  if (theGSM3ShieldV1ModemCore.gss.cb.peek(1)) return 1;
84  else return 0;
85 }
GSM3CircularBuffer cb
char peek(int increment)
GSM3ShieldV1ModemCore theGSM3ShieldV1ModemCore

◆ begin()

void GSM3ShieldV1DirectModemProvider::begin ( void  )

GSM3ShieldV1DirectModemProvider.cpp47 行目に定義があります。

48 {
50 }
int begin(long speed)
GSM3ShieldV1ModemCore theGSM3ShieldV1ModemCore

◆ connect()

void GSM3ShieldV1DirectModemProvider::connect ( )

Enable the debug process.

GSM3ShieldV1DirectModemProvider.cpp63 行目に定義があります。

64 {
66 }
GSM3ShieldV1ModemCore theGSM3ShieldV1ModemCore
void registerActiveProvider(GSM3ShieldV1BaseProvider *provider)

◆ disconnect()

void GSM3ShieldV1DirectModemProvider::disconnect ( )

Disable the debug process.

GSM3ShieldV1DirectModemProvider.cpp69 行目に定義があります。

70 {
72 }
GSM3ShieldV1ModemCore theGSM3ShieldV1ModemCore
void registerActiveProvider(GSM3ShieldV1BaseProvider *provider)

◆ flush()

void GSM3ShieldV1DirectModemProvider::flush ( void  )
virtual

Empty circular buffer

Printを再実装しています。

GSM3ShieldV1DirectModemProvider.cpp107 行目に定義があります。

108 {
110 }
GSM3CircularBuffer cb
GSM3ShieldV1ModemCore theGSM3ShieldV1ModemCore

◆ manageResponse()

void GSM3ShieldV1DirectModemProvider::manageResponse ( byte  from,
byte  to 
)
inlinevirtual

Manages modem response

引数
fromInitial byte of buffer
toFinal byte of buffer

GSM3ShieldV1BaseProviderを再実装しています。

GSM3ShieldV1DirectModemProvider.h102 行目に定義があります。

102 {};

◆ peek()

int GSM3ShieldV1DirectModemProvider::peek ( void  )
virtual

Read from circular buffer, but do not delete it

戻り値
character

Streamを実装しています。

GSM3ShieldV1DirectModemProvider.cpp101 行目に定義があります。

102 {
104 }
GSM3CircularBuffer cb
char peek(int increment)
GSM3ShieldV1ModemCore theGSM3ShieldV1ModemCore

◆ read()

int GSM3ShieldV1DirectModemProvider::read ( void  )
virtual

Read from circular buffer

戻り値
character

Streamを実装しています。

GSM3ShieldV1DirectModemProvider.cpp88 行目に定義があります。

89 {
90  int dataRead;
91  dataRead = theGSM3ShieldV1ModemCore.gss.cb.read();
92  //In case last char in xof mode.
93  if (!(theGSM3ShieldV1ModemCore.gss.cb.peek(0))) {
95  delay(100);
96  }
97  return dataRead;
98 }
void delay(unsigned long)
Definition: wiring.c:106
GSM3CircularBuffer cb
char peek(int increment)
GSM3ShieldV1ModemCore theGSM3ShieldV1ModemCore

◆ recognizeUnsolicitedEvent()

bool GSM3ShieldV1DirectModemProvider::recognizeUnsolicitedEvent ( byte  from)
inlinevirtual

Recognize unsolicited event

引数
from
戻り値
true if successful

GSM3ShieldV1BaseProviderを再実装しています。

GSM3ShieldV1DirectModemProvider.h108 行目に定義があります。

108 {return false;};

◆ restartModem()

void GSM3ShieldV1DirectModemProvider::restartModem ( )

GSM3ShieldV1DirectModemProvider.cpp52 行目に定義があります。

53 {
56  delay(12000);
58  delay(1000);
59 
60 }
void pinMode(uint8_t, uint8_t)
void delay(unsigned long)
Definition: wiring.c:106
void digitalWrite(uint8_t, uint8_t)
#define LOW
Definition: Arduino.h:41
#define HIGH
Definition: Arduino.h:40
#define OUTPUT
Definition: Arduino.h:44

◆ write()

size_t GSM3ShieldV1DirectModemProvider::write ( uint8_t  c)
virtual

Debug write to modem by means of SoftSerial.

引数
cCharacter
戻り値
size

Printを実装しています。

GSM3ShieldV1DirectModemProvider.cpp75 行目に定義があります。

76 {
78 }
GSM3ShieldV1ModemCore theGSM3ShieldV1ModemCore

◆ writeModemCommand()

String GSM3ShieldV1DirectModemProvider::writeModemCommand ( String  command,
int  delay 
)

Send AT command to modem

引数
commandAT command
delayTime to wait for response
戻り値
response from modem

GSM3ShieldV1DirectModemProvider.cpp112 行目に定義があります。

113 {
114 
115  if(trace)
116  Serial.println(ATcommand);
117 
118  // Flush other texts
119  flush();
120 
121  //Enter debug mode.
122  connect();
123  //Send the AT command.
124  println(ATcommand);
125 
126  delay(responseDelay);
127 
128  //Get response data from modem.
129  String result = "";
130  if(trace)
132 
133  while (available())
134  {
135  char c = read();
136  result += c;
137  }
138  if(trace)
139  Serial.println(result);
140  //Leave the debug mode.
141  disconnect();
142  return result;
143 }
void delay(unsigned long)
Definition: wiring.c:106
int result
Definition: ard_spi.c:174
GSM3CircularBuffer cb
size_t println(void)
Definition: Print.cpp:126
GSM3ShieldV1ModemCore theGSM3ShieldV1ModemCore

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