FlashAir PocketReference

※本サイトに記載されているFlashAir関連の情報は、
 参考のために残しており、古い情報を含みます。
 現在主に更新しているのはwikiですので、最新の情報はwikiを参照してください。

FTLEに内蔵している簡易リファレンスをここでものせることにしました。
参考程度にどうぞ。

FlashTools Pocket Reference

request HTTPリクエストの発行
HTTPGetFile HTTPを使用したファイルのダウンロード
pio SDインターフェースのPIO制御
FTP FTPを使用したファイルのアップロード、ダウンロード
hash ハッシュの計算
Scan SSIDスキャンの実行
GetScanInfo SSIDスキャン結果の取得
Connect STAモードで無線LANの有効化
Establish APモードで無線LANの有効化
Bridge インターネット同時接続モードで無線LANの有効化
Disconnect 無線LANの停止
sleep 指定時間だけスクリプトの実行を停止します
sharedmemory 共有メモリからデータを読み込み或いは書き込みを行います
SetCert ルート証明登録
strconvert 文字列変換
SetChannel 無線チャネルを設定する
MailSend メール送信を行う
spi SPI操作を行う

--- Unoffical ---

remove ファイルの削除
rename ファイル名変更
WlanLink 接続状態
ConnectNum 接続台数取得
getStatus 接続種別取得
IBSS アドホックモードで無線LANの有効化
ReadStatusReg iSDIOステータスレジスタを読みだす
ping pingを発行する
SetCurrentTime 現在時刻をFAT形式で設定する
StartWPS WPS設定を開始する
ReadResponse (不明)
SetSecretCode (不明)
ClrSecretCode (不明)
SetRmHeader (不明)

--- 解説 ---

request HTTPリクエストの発行
b, c, h = fa.request(url [, method [, headers [, file [, body [, bufsize [, redirect]]]]]])
b, c, h = fa.request{url="http://example.com/",file="Hello.txt"}
HTTPGetFile HTTPを使用したファイルのダウンロード
result = fa.HTTPGetFile(uri, filepath [, user, pass])
result: 1 = Success , nill = Error
pio SDインターフェースのPIO制御
s, indata = fa.pio(ctrl, data)
ctrl : 1 = OUTPUT, 0 = INPUT
data/indata : 1 = HIGH, 0 = LOW
s: 1 = OK , 0 = Error
FTP FTPを使用したファイルのアップロード、ダウンロード
result = fa.FTP(cmd, uri, filename)
result: 1 = Success , nill = Error
hash ハッシュの計算
hash=fa.hash(name, data, key)
name: string(md5,sha1,sha256,hmac-sha256)
hash: string(HEX)
Scan SSIDスキャンの実行
count = fa.Scan([ssid])
disconnect状態でのみ有効。
GetScanInfo SSIDスキャン結果の取得
ssid, other = fa.GetScanInfo(num)
num: index
Connect STAモードで無線LANの有効化
fa.Connect(ssid, networkkey)
Establish APモードで無線LANの有効化
fa.Establish(ssid, networkkey, encmode)
encmode: 0=Open, 1=Open/WEP, 2=Shared/WEP, 3=WPA TKIP, 4=WPA AES, 5=WPA2 TKIP, 6=WPA2 AES
Bridge インターネット同時接続モードで無線LANの有効化
fa.Bridge(ssid, networkkey, encmode, brgssid, brgnetworkkey)
Disconnect 無線LANの停止
fa.Disconnect()
sleep 指定時間だけスクリプトの実行を停止します
fa.Disconnect()
sharedmemory 共有メモリからデータを読み込み或いは書き込みを行います
result = fa.sharedmemory(command, addr, len, wdata)
addr: [0 - 511]
len: [0 - 512]
wdata: string
command: "write", "read"
result: Write > 1 = Success , nill = Error
result: Read > (Read string) = Success , nill = Error
SetCert ルート証明登録
result = fa.SetCert(filename)
result: 1 = Success , nill = Error
strconvert 文字列変換
result = fa.strconvert(format, orgstr)
format: "sjis2utf8" or "utf82sjis"
result: (Converted string) = Success , nill = Error
SetChannel 無線チャネルを設定する
fa.SetChannel(channelNo)
MailSend メール送信を行う
result = fa.MailSend(from,headers,body,server,user,password, attachment, ContentType)
fa.MailSend {from = "a@a.jp", headers = "To:..."}
result: "MailSend is success." or "Error: It failed to send."
spi SPI操作を行う
result = fa.spi(command,data)
command: "init", "mode", "bit", "write", "read"
result: write > num(Received data)
result: read > num(Received data)
result: other > status(?)
remove ファイルの削除
fa.remove(fname)
rename ファイル名変更
fa.rename(src,snk)
変更先のファイル名が重複している場合は(1)などが自動で付加される。
WlanLink 接続状態
result = fa.WlanLink()
result: 1=Connected, nil = Disconnected
ConnectNum 接続台数取得
result = fa.ConnectNum()
result: num = (How many Connected Terms)
getStatus 接続種別取得
result = fa.getStatus()
result: "Bridge"/ "AP_CONNECTED" / "AP" / "STA" / "NO CONNECTED"
IBSS アドホックモードで無線LANの有効化
result = fa.IBSS(ssid, networkkey, encmode)
result: IP Address(string)
ReadStatusReg iSDIOステータスレジスタを読みだす
result = fa.ReadStatusReg()
ping pingを発行する
result = fa.ping(ip)
result: 1 = Success , nill = Error
SetCurrentTime 現在時刻をFAT形式で設定する
SetCurrentTime(FAT_YMD_bits,FAT_HMS_bits)
StartWPS WPS設定を開始する
ReadResponse (不明)
SetSecretCode (不明)
ClrSecretCode (不明)
SetRmHeader (不明)

New
reboot再起動する。その際、CONFIGが読み直される。
fa.reboot()
sysclk???
stackスタックの使用量らしきものを得る。
result = fa.stack()
result: 81%

ピン対応表 [Pin Assignment]
Pin fa.pio pioduino SD SD Pin Airio MTO-EV101 AirioRP SPI-1 SPI-2 AKI K-05818 fa.spi
PIN 0 0x01 0 CMD 2 SW1 MISO CMD DI MOSI SDI MOSI(out)
PIN 1 0x02 1 DAT0 7 Red MOSI DAT0 DO MISO SDO SCLK(out)
PIN 2 0x04 2 DAT1 8 Blue DAT1 DAT1 DAT1 NC DAT1(↓NC) /SS(out)
PIN 3 0x08 3 DAT2 9 Green DAT2 DAT2 DAT2 NC DAT2(↑NC) MISO(in)
PIN 4 0x10 4 CD/DAT3 1 NC CS DAT3 CS CS CS INT(in)

Comments