Nefryのライブラリーを使用していただきありがとうございます。
こちらのドキュメントは随時更新していきます。
Arduino IDEでのプログラミングを想定しています。
Arduino IDEの使用時には#include<Nefry.h>を入力してから使用してください。
関数を呼び出す時には"Nefry.関数()"とすることで使うことができます。
一例ですが、Nefry.print("test");やNefry.reset();このように使うことができます。
#Nefry表示関数
Nefryのwebconsoleとserialに文字を表示します。Serialはデフォルトでは115200bpsで通信します。
##各種型
float
double
char
int
long
unsigned char
unsigned int
unsigned long
String が含まれます。
##print(各種型 t)
Nefryのwebconsoleとserialに文字を表示します。改行なしです。
###t
表示したい文字(列)を入力してください。
##println(各種型 t)
Nefryのwebconsoleとserialに文字を表示します。改行ありです。
###t
表示したい文字(列)を入力してください。
##available(void)
Nefryのwebconsoleで入力された文字数を返します。返却値 int型
##read(void)
Nefryのwebconsoleで入力された文字を返します。返却値 String型
#その他の便利な関数
##getModuleName()
v2.0.1追加
割り振られたモジュール名を取得することができます。返却値 char* 型
##autoConnect(int sec)
v1.4.0追加
loopの中でWifiが切れた時に自動接続します。接続できているときはTrue、接続できていないときはFalseで値が返されます
###sec
接続にどの程度時間をかけていいのか指定します。1-2秒程度がお勧めです
##ndelay(unsigned long ms)
v1.1.2追加
delayではすべての処理が止まってしまいますがこちらを選ぶことでNefryのWeb表示を継続することができます。
基本的に500ミリ秒以上の待ち時間になる場合はこちらを選んでください。
###ms
ミリ秒で時間を指定します。1000ミリ秒＝1秒
##reset(void)
Nefryをリセットし、プログラムを初めからやり直します。
##sleep(int sec)
Nefryをスリープモードにします。スリープモードに入ると処理ができません。スリープが終わった後はプログラムを初めからやり直します。
スリープモードを終わらすにはNefry本体のリセットボタンを押すか、指定した時間が経つのを待つしかありません。
0を入力することで、無期限スリープモードになります。
###sec
ここにスリープする秒数を入力します。単位は秒です。
##push_SW(void)
Nefry本体にあるSWを使うことができます。返却値は bool型
スイッチを押したときにtrue、押さなかったときにfalseが返却されます。
#データ保存
電源が切れてもデータを保持し続けることができます。NefryのModule設定ページからも保存できます。
char配列で0-2は127文字まで、3-7は63文字まで保存することができます。
modeは数値をInt型で覚えることができ、0-7の8つを記憶することができます。
##setConfStr(const char *pt, int num)
v1.2.0 名称変更 旧関数名 memory_write
v1.1.2変更
Nefryのメモリーにデータを保存します。この関数を使うことで通常はsleepやresetの時に失われていたデータ保存しリセット後も使うことができます。
###*pt
保存したい文字列データのアドレスを受け渡しします。
###num
どの場所にデータを保存するか指定します。範囲は0-7です。
##getConfStr(int num)
v1.2.0 名称変更 旧関数名 memory_read
v1.1.2変更
Nefryのメモリーに保存したデータを呼び出すことができます。char型のポインタで返却されます。
###num
データを保存した場所を指定します。範囲は0-7です。
##setConfValue(const int pt, const int num)
v1.2.0 名称変更 旧関数名 memory_write_mode
v1.1.2追加
Nefryのメモリーにデータを保存します。この関数を使うことで通常はsleepやresetの時に失われていたデータ保存しリセット後も使うことができます。
###pt
保存したい数値データを受け渡しします。
###num
どの場所にデータを保存するか指定します。範囲は0-7です。
##getConfValue(const int num)
v1.2.0 名称変更 旧関数名 memory_read_mode
v1.1.2追加
Nefryのメモリーに保存したデータを呼び出すことができます。intの値で返却されます。
###num
データを保存した場所を指定します。範囲は0-7です。
#各種設定
こちらの関数はすべてWeb上で設定することが可能ですが、プログラミングして変更することが可能です。設定内容は自動的保存されWebで表示される内容と同一になります。
##setProgramName(const char* name)
v1.4.0追加
プログラム名を指定することができます。指定するとSetModuleページで表示されます。
###name
プログラム名
##getProgramName()
v1.4.0追加
プログラム名を確認することができます。返却値はStringです。
##setConfHtmlPrint(const bool data, const int num)
v1.4.0追加予定
SetModuleで設定項目を表現するかしないかを指定することが可能になります。
###data
0：非表示
1：表示
###num
どの項目を指定するのか
0-7は文字が入力できる入力欄
10-17は数値が入力できる入力欄
##getConfHtmlPrint(const int num)
v1.4.0追加予定
SetModuleで設定項目を表現するかしないかを指定することが可能になります。
どのような指定がされているか取得することが可能です。返り値はboolです。
###num
どの項目を指定するのか
0-7は文字が入力できる入力欄
10-17は数値が入力できる入力欄
##setConfHtml(char set[15], int num)
v1.2.0 名称変更 旧関数名 setHtmlConf
v1.1.2追加
SetModuleのHTMLファイルを編集します。デフォルトでmemoと表示される部分を変更しています。
###set
表示する文字を指定します
###num
データを保存した場所を指定します。範囲は0-18です。
0-8 は文字入力欄
10-18 は数値入力欄
##setConfWifi(const char SSID[32], const char pass[64])
v1.2.0 名称変更 旧関数名 setWifiConf
v1.1.2追加
Nefryが接続するWiFiを指定します。この関数で指定したものは自動的に保存されます。
###SSID
接続するアクセスポイントのSSID
###pass
接続するアクセスポイントのパスワード
##setConfModule(const char module_id[32], const char module_class[32], const char module_wifi_pass[64])
v1.2.0 名称変更 旧関数名 setModuleConf
v1.1.2追加
Nefryに関するモジュール設定をすることができます。この関数で指定したものは自動的に保存されます。
##setConfUser(const char user[32], const char pass[32])
v1.2.0 名称変更 旧関数名 setUserConf
v1.1.2追加
Nefryの認証に関する設定をすることができます。
#認証
外部からの操作を受ける際に必要な機能です。
認証機能で使える文字数は(UserID,User_pass,Nefryclass,NefryID)各31文字までとなっています。
##login(const char *UserID, const char *User_pass)
v1.2.0 名称変更 旧関数名 Nefry_login
NefryのModule設定ページから設定したIDとpassが両方等しいかどうか確認してくれます。
等しい場合はtrue,等しくない場合はfalseとなります。
###UserID
ユーザー名
###User_pass
ユーザパスワード
##Auth(const char *Nefryclass, const char *NefryID)
v1.2.0 名称変更 旧関数名 Nefry_Auth
NefryのModule設定ページから設定したIDかclassがどちらか等しいかどうか確認してくれます。
IDは自動的にNefry-(4桁の固有ID)が割り振られますが、classは自動的に割り振られないので注意してください。
どちらか一つでも等しい場合はtrue,等しくない場合はfalseとなります。
###Nefryclass
Nefryを複数制御したい場合は同じclassを割り振ってください。
###NefryID
一つのNefryを制御したい場合に使用ください。
#LED制御関数
NefryについているRGBLEDを制御するための関数です。
##beginLed(int num, int pin, uint8_t t)
v1.2.0 名称変更 旧関数名 Nefry_LED_begin
NefryについているLEDを制御を始める際に必要な処理です。
###num
何個のLEDを制御するか入力します。1以上
###pin
何番ピンで制御するか入力します。
###t
LEDのmodeを設定します。(Adafruit_NeoPixelライブラリーを参照)
##setLed(char r, char g, char b, char w, char pin, int num)
v1.2.0 名称変更 旧関数名 Nefry_LED
NefryのLEDを制御します。指定なしの場合Nefry標準のLEDの制御になります。
###r,g,b
赤色、緑色、青色の色を制御します。数値の範囲は0-255
###w(指定なし可)
明るさを制御します。数値の範囲は0-255
###pin(指定なし可)
何番ピンで制御するか入力します。
###num(指定なし可)
Nefryから見て接続しているのが何個目のLEDを制御するか入力します。1つしかつながっていないときは0。3つ繋がっていて、3つ目を制御したいときは2、2つ目なら1となります。