Ethernet

Arduino Ethernetボードやシールドを使い、ネットワーク接続(ローカル/インターネット)を行う。

このライブラリを使うと、Arduino Ethernet(シールドもしくはボード)をインターネットに接続できる。ライブラリは、クライアントとサーバの機能を提供する。DNSを使ってローカルネットワークに接続したり、DNSの解決を行うこともできる。

リポジトリ

互換性

このライブラリは全てのアーキテクチャで利用できるので、全てのArduinoボードで利用できる。

リリース

このライブラリを使うためには、Arduino IDEでライブラリマネージャを開きインストールする。

使用方法

このライブラリは、Arduino Ethernet ShieldとArduino Ethernet Shield2、Leonardo Ethernet、他のW5100/W5200/W5500ベースのデバイスで動作する。 Ethernetシールドとこのライブラリを使うことで、Arduinoボードをインターネットに接続することができる。このライブラリは、サーバとして接続を受け付けることも、クライアントとして外部への接続を行うこともできる。このライブラリは8つ(ただし、W5100とSRAMが2kB以下のボードでは4つまで)のコネクションまで同時に確立することができる(サーバ・クライアントもしくは混在)。

ArduinoはシールドとSPIバスを使って通信する。このために利用するのは、デジタルピンの11番と12番、13番（Unoの場合）、あるいは、50番と51番、52番（Megaの場合）である。どちらのボードでも、10番はSSとして利用する。Megaでは、53番（ハードウェアSSピン）はW5100を選択するためには使わず、出力として確保しておく必要がある。そうでないと、SPIインターフェイスは動作しない。

このライブラリを使うためには、以下を宣言する。

1
2

#include <SPI.h> 
#include <Ethernet.h>
EthernetClass
begin()
Ethernetライブラリとネットワーク設定を初期化する。
dnsServerIP()
DNSサーバのIPアドレスを取得する。
gatewayIP()
ゲートウェイのIPアドレスを取得する。
hardwareStatus()
WIZnetイーサネットコントローラの種類を取得する。
init()
イーサネットコントローラのCSピンを設定する。
linkStatus()
イーサネットコントローラのリンク状態を返却する。
localIP()
EthernetシールドのIPアドレスを取得する。
MACAddress()
EthernetシールドのMACアドレスを設定する。
maintain()
DHCPリースの期限を延長する。
setDnsServerIP()
DNSサーバのIPアドレスを設定する。
setGatewayIP()
DNSサーバのIPアドレスを設定する。
setLocalIP()
デバイスのIPアドレスを設定する。
setMACAddress()
MACアドレスを設定する。
setRetransmissionCount()
送信の試行回数を設定する。
setRetransmissionTimeout()
イーサネットコントローラのタイムアウトを設定する。
setSubnetMask()
ネットワークのサブネットマスクを設定する。
subnetMask()
デバイスのサブネットマスクを返却する。
IPAddress
IPAddress()
IPアドレスを定義する。
EthernetServer
Server
Ethernetサーバのベースクラス。
EthernetServer()
指定したポートへの接続を待ち受けるサーバを作成する。
begin()
指定したポートへの接続を待ち受けるサーバを作成する。
accept()
クライアントからの接続を管理する。
available()
読み取り用のデータが利用可能な、サーバに接続しているクライアントを取得する。
if(server)
サーバが新しいクライアントをlistenしているかを示す。
write()
サーバに接続しているすべてのクライアントにデータを書く。
print()
サーバに接続しているすべてのクライアントにデータを書く。
println()
サーバに接続しているすべてのクライアントにデータを書く。
EthernetClient
Client
Ethernetクライアントのベースクラス。
EthernetClient()
指定したIPアドレスのポートに接続できるクライアントを生成する。
if(EthernetClient)
指定したイーサネットクライアントが利用可能かを示す。
connected()
クライアントが接続しているかを調べる。
connect()
指定したIPアドレスのポートに接続する。
localPort()
指定したIPアドレスのポートに接続する。
remoteIP()
クライアントのIPアドレスを返却する。
remotePort()
現在の着信パケットを送信したホストのポート番号を返却する。
setConnectionTimeout()
EthernetClient::connect()とEthernetClient::stop()のタイムアウトを設定する。
write()
クライアントが接続しているサーバにデータを書き込む。
print()
クライアントが接続しているサーバにデータを書く。
println()
クライアントが接続しているサーバにデータと改行コードを書く。
available()
読み込み可能なバイト数を返却する。
read()
クライアントが接続しているサーバから(最後にread()を呼んだ）次のバイトを読み取る。
flush()
全ての送信データがバッファから送信されるまで待つ。
stop()
サーバから切断する。
EthernetUDP
begin()
EthernetUDPライブラリとネットワーク設定を初期化する。
read()
指定したバッファにUDPデータを読み込む。
write()
リモート接続先にUDPデータを書き出す。
beginPacket()
ローカルコネクションからリモートコネクションに対してUDPデータの書き込みを開始する。
endPacket()
リモートコネクションに対してUDPデータを書き込んだ後に呼ぶ。
parsePacket()
リモートコネクションに対してUDPデータを書き込んだ後に呼ぶ。
available()
バッファから読み込み可能なデータのバイト数を返す。
UDP
stop()
サーバから切断する。
remoteIP()
リモートコネクションのIPアドレスを取得する。
remotePort()
リモートコネクションのポートを取得する。

オリジナルのページ

https://www.arduino.cc/reference/en/libraries/ethernet/

inserted by FC2 system