View on GitHub

Wiki

リファレンスマニュアル

種類 識別子
定数 WIO_TCP
  WIO_UDP
  WIO_D38
  WIO_D39
  WIO_D20
  WIO_D19
  WIO_A6
  WIO_A7
  WIO_A4
  WIO_A5
  WIO_UART_D23
  WIO_UART_D22
  WIO_I2C_D24
  WIO_I2C_D25
  WioCellular::SOCKET_TCP
  WioCellular::SOCKET_UDP
関数 GetLastError
  Init
  PowerSupplyCellular
  PowerSupplyLed
  PowerSupplyGrove
  LedSetRGB
  TurnOnOrReset
  TurnOff
  GetIMEI
  GetIMSI
  GetICCID
  GetPhoneNumber
  GetReceivedSignalStrength
  GetTime
  SetAccessTechnology
  SetSelectNetwork
  WaitForCSRegistration
  WaitForPSRegistration
  Activate
  Deactivate
  SocketOpen
  SocketSend
  SocketReceive
  SocketClose
  HttpGet
  HttpPost
  SendUSSD
  SystemReset

定数

WIO_TCP

TCP通信の指定です。 SocketOpen()の引数に使用します。

WIO_UDP

UDP通信の指定です。 SocketOpen()の引数に使用します。

WIO_D38

GroveコネクターピンD38のピン番号です。 pinMode(), digitalRead(), digitalWrite()の引数に使用します。

WIO_D39

GroveコネクターピンD39のピン番号です。 pinMode(), digitalRead(), digitalWrite()の引数に使用します。

WIO_D20

GroveコネクターピンD20のピン番号です。 pinMode(), digitalRead(), digitalWrite()の引数に使用します。

WIO_D19

GroveコネクターピンD19のピン番号です。 pinMode(), digitalRead(), digitalWrite()の引数に使用します。

WIO_A6

GroveコネクターピンA6のピン番号です。 pinMode(), analogRead(), digitalRead(), digitalWrite()の引数に使用します。

※analogReadを利用する際は pinMode(WIO_A6, INPUT_ANALOG); を指定してください。

WIO_A7

GroveコネクターピンA7のピン番号です。 pinMode(), analogRead(), digitalRead(), digitalWrite()の引数に使用します。

※analogReadを利用する際は pinMode(WIO_A7, INPUT_ANALOG); を指定してください。

WIO_A4

GroveコネクターピンA4のピン番号です。 pinMode(), analogRead(), digitalRead(), digitalWrite()の引数に使用します。

※analogReadを利用する際は pinMode(WIO_A4, INPUT_ANALOG); を指定してください。

WIO_A5

GroveコネクターピンA5のピン番号です。 pinMode(), analogRead(), digitalRead(), digitalWrite()の引数に使用します。

※analogReadを利用する際は pinMode(WIO_A5, INPUT_ANALOG); を指定してください。

WIO_UART_D23

GroveコネクターピンD23のピン番号です。 pinMode(), digitalRead(), digitalWrite()の引数に使用します。

WIO_UART_D22

GroveコネクターピンD22のピン番号です。 pinMode(), digitalRead(), digitalWrite()の引数に使用します。

WIO_I2C_D24

GroveコネクターピンD24のピン番号です。 pinMode(), digitalRead(), digitalWrite()の引数に使用します。

WIO_I2C_D25

GroveコネクターピンD25のピン番号です。 pinMode(), digitalRead(), digitalWrite()の引数に使用します。

WioCellular::SOCKET_TCP

TCP通信の指定です。 SocketOpen()の引数に使用します。

WioCellular::SOCKET_UDP

UDP通信の指定です。 SocketOpen()の引数に使用します。

関数

GetLastError

ErrorCodeType GetLastError() const

戻り値

説明
最後に実行した関数のエラーコードを返します。

説明

一番最後に実行した関数のエラーコードを返します。エラーが無いときはE_OKを返します。

Init

void Init()

説明

Wioを初期化します。 初期化直後は、全ての電源がオフします。

PowerSupplyCellular

void PowerSupplyCellular(bool on)

引数

引数 説明
on 電源供給のオン/オフ。オンしたいときはtrue、オフしたいときはfalseを指定します。

説明

Wio上のセルラーモジュールの電源供給をオン/オフします。 セルラーモジュールは電源供給オンの後に、起動操作(TurnOnOrReset)しないと利用できません。 本関数を実行した後の、セルラーモジュールの操作は0.5秒以上待ってください。(セルラーモジュールの動作が安定するまで待つ。)

PowerSupplyLed

void PowerSupplyLed(bool on)

引数

引数 説明
on 電源供給のオン/オフ。オンしたいときはtrue、オフしたいときはfalseを指定します。

説明

フルカラーLEDへの電源供給をオン/オフします。

PowerSupplyGrove

void PowerSupplyGrove(bool on)

引数

引数 説明
on 電源供給のオン/オフ。オンしたいときはtrue、オフしたいときはfalseを指定します。

説明

Groveコネクター D20/A4/A6/I2C/UARTの電源供給をオン/オフします。

Groveコネクター D38の電源は常時オンです。

LedSetRGB

void LedSetRGB(byte red, byte green, byte blue)

引数

引数 説明
red 赤色の度合い。0~255を指定します。
green 緑色の度合い。0~255を指定します。
blue 青色の度合い。0~255を指定します。

説明

Wio上のフルカラーLEDを点灯します。 消灯したいときは、red/green/blue全てに0を指定します。

TurnOnOrReset

bool TurnOnOrReset()

戻り値

説明
成功したときはtrue、失敗したときはfalseを返します。

説明

Wio上のセルラーモジュールを起動操作します。 セルラーモジュールが電源オンしていないときは電源オン、電源オンしているときはリセットします。 本関数を実行する前に、セルラーモジュールへ電源供給(PowerSupplyCellular)してください。

TurnOff

bool TurnOff()

戻り値

説明
成功したときはtrue、失敗したときはfalseを返します。

説明

Wio上のセルラーモジュールを停止操作します。

GetIMEI

int GetIMEI(char* imei, int imeiSize)

引数

引数 説明
imei IMEIを取得する変数。文字列。
imeiSize imeiのバイト数。

戻り値

説明
成功したときはIMEIの文字数、失敗したときはマイナス値を返します。

説明

WioのIMEIを取得します。

GetIMSI

int GetIMSI(char* imsi, int imsiSize)

引数

引数 説明
imsi IMSIを取得する変数。文字列。
imsiSize imsiのバイト数。

戻り値

説明
成功したときはIMSIの文字数、失敗したときはマイナス値を返します。

説明

Wioに取り付けられたSIMのIMSIを取得します。

GetICCID

int GetICCID(char* iccid, int iccidSize)

引数

引数 説明
iccid ICCIDを取得する変数。文字列。
iccidSize iccidのバイト数。

戻り値

説明
成功したときはICCIDの文字数、失敗したときはマイナス値を返します。

説明

Wioに取り付けられたSIMのICCIDを取得します。

GetPhoneNumber

int GetPhoneNumber(char* number, int numberSize)

引数

引数 説明
number 電話番号を取得する変数。文字列。
numberSize numberのバイト数。

戻り値

説明
成功したときは電話番号の文字数、失敗したときはマイナス値を返します。

説明

Wioに取り付けられたSIMの電話番号を取得します。

GetReceivedSignalStrength

int GetReceivedSignalStrength()

戻り値

説明
受信信号強度[dBm]を返します。失敗したときはINT_MIN(limits.h)を返します。

説明

セルラーモジュールが受信している信号強度[dBm]を取得します。

GetTime

bool GetTime(struct tm* tim)

引数

引数 説明
tim 日時を取得する変数。

戻り値

説明
成功したときはtrue、失敗したときはfalseを返します。

説明

セルラーモジュールが保持している日時を取得します。

SetAccessTechnology

Seeed Wio LTE M1/NB1(BG96)で使用可能。

void SetAccessTechnology(AccessTechnologyType technology)

引数

引数 説明
technology セルラー通信のテクノロジー。LTE Cat.M1はACCESS_TECHNOLOGY_LTE_M1、LTE Cat.NB1はACCESS_TECHNOLOGY_LTE_NB1を指定します。

説明

セルラー通信のテクノロジーを指定します。

SetSelectNetwork

void SetSelectNetwork(SelectNetworkModeType mode, const char* plmn = NULL)

引数

引数 説明
mode ネットワークの選択方法。自動はSELECT_NETWORK_MODE_AUTOMATIC、IMSIから導出はSELECT_NETWORK_MODE_MANUAL_IMSI、手動はSELECT_NETWORK_MODE_MANUALを指定します。手動のときは、plmnを指定してください。
plmn PLMN。(Public land mobile network)

説明

セルラー通信のネットワーク選択方法を指定します。

WaitForCSRegistration

bool WaitForCSRegistration(long timeout = 120000)

引数

引数 説明
timeout タイムアウト時間[ミリ秒]。

戻り値

説明
成功したときはtrue、失敗したときはfalseを返します。

説明

CSネットワークに登録完了するまで待ちます。

WaitForPSRegistration

bool WaitForPSRegistration(long timeout = 120000)

引数

引数 説明
timeout タイムアウト時間[ミリ秒]。

戻り値

説明
成功したときはtrue、失敗したときはfalseを返します。

説明

PSネットワークに登録完了するまで待ちます。

Activate

bool Activate(const char* accessPointName, const char* userName, const char* password, long waitForRegistTimeout = 120000)

引数

引数 説明
accessPointName APN。
userName ユーザー名。
password パスワード。
waitForRegistTimeout タイムアウト時間[ミリ秒]。

戻り値

説明
成功したときはtrue、失敗したときはfalseを返します。

説明

指定したAPN、ユーザー名、パスワードを使って、データ通信を有効にします。

Deactivate

bool Deactivate()

戻り値

説明
成功したときはtrue、失敗したときはfalseを返します。

説明

データ通信を無効にします。

SocketOpen

int SocketOpen(const char* host, int port, SocketType type)

引数

引数 説明
host 接続先のホスト名。
port 接続先のポート番号。
type ソケット通信の種類。TCP通信はWIO_TCP、UDP通信はWIO_UDPを指定します。

戻り値

説明
成功したときは接続ID、失敗したときはマイナス値を返します。

説明

指定したホスト名、ポート番号に、ソケット通信を接続します。 同時に12個まで接続することが可能です。

SocketSend

bool SocketSend(int connectId, const byte* data, int dataSize)
bool SocketSend(int connectId, const char* data)

引数

引数 説明
connectId 接続ID。
data 送信するデータ。
dataSize 送信するデータのバイト数。

戻り値

説明
成功したときはtrue、失敗したときはfalseを返します。

説明

指定した接続へデータを送信します。 一度に送信できるデータは1460バイト以下です。

SocketReceive

int SocketReceive(int connectId, byte* data, int dataSize)
int SocketReceive(int connectId, char* data, int dataSize)
int SocketReceive(int connectId, byte* data, int dataSize, long timeout)
int SocketReceive(int connectId, char* data, int dataSize, long timeout)

引数

引数 説明
connectId 接続ID。
data 受信したデータを取得する変数。
dataSize dataのバイト数。
timeout タイムアウト時間[ミリ秒]。

戻り値

説明
受信したデータが無いときはゼロ、有るときはデータのバイト数、失敗したときはマイナス値を返します。

説明

指定した接続に受信したデータを取得します。 受信したデータが無いときはゼロを返します。 タイムアウト時間を指定したときは、その時間、受信を待ちます。

SocketClose

bool SocketClose(int connectId)

引数

引数 説明
connectId 接続ID。

戻り値

説明
成功したときはtrue、失敗したときはfalseを返します。

説明

指定した接続をクローズします。

HttpGet

int HttpGet(const char* url, char* data, int dataSize)
int HttpGet(const char* url, char* data, int dataSize, const WioCellularHttpHeader& header)

引数

引数 説明
url 接続するURL。例:”http://test.co.jp”, “https://test.co.jp”
data 受信したデータを取得する変数。
dataSize dataのバイト数。
header カスタムHTTPヘッダ。

戻り値

説明
成功したときはデータの文字数、失敗したときはマイナス値を返します。

説明

指定したURLから、HTTP通信でGETします。

HttpPost

bool HttpPost(const char* url, const char* data, int* responseCode)
bool HttpPost(const char* url, const char* data, int* responseCode, const WioCellularHttpHeader& header)

引数

引数 説明
url 接続するURL。例:”http://test.co.jp”, “https://test.co.jp”
data 送信するデータ。
responseCode 受信したHTTPレスポンスステータスコードを取得する変数。
header カスタムHTTPヘッダ。

戻り値

説明
成功したときはtrue、失敗したときはfalseを返します。

説明

指定したURLへ、HTTP通信でPOSTします。

SendUSSD

bool SendUSSD(const char* in, char* out, int outSize)

引数

引数 説明
in 送信するデータ。
out 受信したデータを取得する変数。
outSize outのバイト数。

戻り値

説明
成功したときはtrue、失敗したときはfalseを返します。

説明

USSDでメッセージ交換します。

SystemReset

static void SystemReset()

説明

CPUをリセットします。