WebSocketを一言で表すと、小さなサイズのデータフレームでリアルタイムに双方向通信ができるHTTPの欠点を補ったプロトコルです。

WebSocketはそう新しいプロトコルでもないのですが、使用するにはブラウザが対応していることが前提です。現在では身近なブラウザではほぼ大部分が対応しているために問題はありません。

WebSocketの汎用的な解説詳細は専門のWEBエンジニアが得意とするところで、ここではどちらかといえば番外で応用する側ですので組み込みマイコンシステムで実現するにあたり特有な部分に限定して解説します。

WebSocketを実装するにあたっては組み込み系のエンジニアにとってはHTMLとJavaScriptの使い勝手が組み込みプログラミングとは少し違うため慣れていない場合は苦労するのではないでしょうか。

WebSocketを開始するきっかけはクライアント側のブラウザからHTMLの中に埋め込んだJabaScriptで記述したWebSocketリクエストを送ることです。これはHTMLページを起動するときにリクエストを発行してもよいし、ページ内に作成した接続開始ボタンを押したときにリクエストを発行する仕様にしてもよいです。

WebSocket通信はしくみを理解するのはそう難しくはないですが、初めての実装は結構大変です。実装での最大のヤマはブラウザで発行されたWebSocketキーからブラウザへ返すアクセスキーを生成するところです。

アクセスキーさえ生成できれば、あとはHTMLとJavaScriptを駆使するだけですので組み込み系の人にとってはちょっとなじみは薄いかもしれませんがWEBプログラミングに精通している人ならばなんのことはないと思われます。

それではWebSocket通信のコネクション確立までの手順を確認していきます。

以下の図がブラウザからサーバーにアクセスするところから始まるWebSocketのコネクション確立までの流れです。

① まず通常のようにサーバーにアクセスするためにブラウザにIPアドレス/ポートを指定するとブラウザからサーバーへHTTPリクエストが送られます。

② サーバーはブラウザからGETメソッドを受けて、レスポンスを返すのですが、その中にJavaScriptで記述したWebSocketを起動するためのリクエストを埋め込んでおきます。大事なポイントはここで一旦通信を切断しておくことです。

③ 数秒おいてからブラウザはサーバーから送られたレスポンス内のJavaScriptを実行してWebSocketキーを含んだHTTPアップグレードリクエストをサーバーに送ります。

WebSocketを開始する場合はブラウザからHTTPリクエストを受け取った後にレスポンスのメッセージボディにJavaScriptでWebSocketリクエストを埋め込むところが通常の場合と異なります。

WebSocketを開始するためのコードは大体フォーマットは決まっていて、WebSocketオブジェクトを生成することから始めます。オブジェクト名は任意に指定できます。下記のサンプル例ではwsocketとしています。

下記のJavaScript記述したWebSocketリクエストのコードをリクエストのヘッダー部に埋め込んでおきます。

WebSocketイベントとメソッドはJavaScriptのコードで記述し、アプリケーションに応じた処理内容にします。

ブラウザ側でWebSocketリクエストコードを実行するとサーバー側へWebSocketキーを含んだHTTPアップグレードリクエストを送信します。

WebSocketコネクション確立のための最大のポイントがブラウザから渡されたWebSocketキーからアクセスキーを生成するところです。

囲んだ24文字のコードがWebSocketコネクションのためにブラウザが発行したキーです。 一例としてサーバーは受信したGETリクエストの空白前のヘッド部に”Sec-WebSocket-Key”があればWebSocketリクエストと認識し、その後に続く24文字分のキー(xxx...xxx==)を抽出します。

この次が最大のヤマ場であるリクエストのWebSocketキーに対するアクセスキーを生成する部分です。

アクセスキーを言葉で表現すると「リクエストで与えられたブラウザが生成したキーに固定値の"258EAFA5-E914-47DA-95CA-C5AB0DC85B11"を連結して、SHA-1ハッシュと呼ばれる暗号化を行い、Base64エンコードを行った値」となっています。

アクセスキーを生成する手順は上記の流れですが、SHA1ハッシュ値を生成するアルゴリズムは難解のため、これすべてを自力でするのではなくどこかの汎用的なライブラリを利用すべきです。

BASE64エンコードに関しては内容はそう難解ではありませんが、これもライブラリ情報は多いため、利用するほうが得策かもしれません。

アクセスキーが生成できたら、WebSocketコネクション確立のためのHTTPアップグレードレスポンスをブラウザへ返します。

レスポンスのフォーマットは下例のとおりでよいと思います。レスポンス一行目のステータスラインは"HTTP/1.1 101 Switching Protocols"と"HTTP/1.1 101 OK"のどちらでも機能するようです。

生成したアクセスキーが有効であることがブラウザで認識されるとWebSocketコネクションが確立し、WebSocketプロトコルによる双方向通信が始まります。いわゆるサーバーとクライアント(ブラウザ)間でハンドシェイクのやり取りが成立したということになります。

確立するとopenイベントが発火し、定義したイベント内容が実行されます。例えばonopenイベントで”Websocket Connect!!"のメッセージを表示させる処理など記述しておけばよいでしょう。

WebSocketコネクションが確立すると任意のタイミングでブラウザ、サーバー間で双方向通信ができるようになります。WebSocket通信では送受信データにはテキストのみならずバイナリも扱うことができます。

データはWebSocketデータフレームとよばれるフォーマットに従ったものを送受信時に扱います。

データフレームの詳細は下記リンクのサイトで確認してみてください。

一度に送るデータが127文字以下でテキストかバイナリに限定する場合は比較的単純です。

データフレームのフォーマットは1バイト単位のブロックで構成されています。１番目のバイトブロックは通信データが最後のパケットであるかの指定およびデータの種類を指定します。２番目のバイトブロックではデータのマスク有無およびデータ長を指定します。

データのマスク有無ですが、これは決まり事でブラウザからのデータはマスクを付加し、ブラウザへのデータはマスクを付けないことになっています。

言葉での説明はわかりにくいのですが、送受信するデータの具体的な適用例で確認すれば理解しやすいと思いますので、送信、受信の場合で解説していきます。

具体的な例としてブラウザがテキスト文字列"test"を送信する場合で確認します。送受信はTCPソケット通信で行われます。

ブラウザからの送信ではsendメソッドを使用します。

4文字テキストの場合、ブラウザは10バイト分のWebSocketデータフレームを送信します。サーバー側で受信するTCPデータバッファをdata_buffer[]とすると実際にこの受信バッファに読み込まれるデータの例は以下のようになります。

4文字テキストデータは単独パケットなので1番目バイトブロックdata_buffer[0]は先頭ビットFINは1、テキストデータのためopcodeは1となるので16進数表記で0x81となります。

2番目バイトブロックdata_buffer[1]はブラウザからのデータでマスク付きなので先頭ビットMASKは1、データのpayload長は4なので16進数表記で0x84となります。

3-6番目バイトブロックdata_buffer[2]-[5] はブラウザから付加されたマスクキーです。これらは同じデータを再度送っても都度変わります。

7番目以降のバイトブロックdata_buffer[6]-[9] の文字数分がブラウザから送信するテキストデータにマスクでコード化されたものです。コード化したデータはマスクキーを使用して復号することで抽出データunmasked_str[i]を取得します。

抽出データunmasked_str[i]はMask_Key[i]とmasked_data[i]のXOR(論理演算)によりUnMask(復号)して取得します。

ブラウザは任意のテキストデータやバイナリデータ以外にも送信するコードがあります。その一例としてcloseメソッドでwsocket.close()を実行した場合のやり取りされるデータを確認してみます。

この場合のブラウザから送信されるデータ列は実データを含まない6バイト分のデータフレームです。最初のバイトブロックのopcodeがcloseメソッドを実行したときは0x8となっています。マスクキーも送信されてきますがここでは意味はありません。

サーバー側で受信した先頭のバイトブロックdata_buffer[0]が0x88であればブラウザでcloseメソッドを実行したことがわかります。

WebSocketのopcodeには、他に0x9(Ping), 0xA(Pong)がよく使用されます。切断したときの処理などに利用できます。

実際にやり取りされる具体的なデータで確認していくとすぐに理解できたのではないでしょうか。次はサーバーからの送信を確認していきます。

今度はサーバー内のテキスト文字列"test"をブラウザに送信する場合で動作を確認します。サーバーからの場合はマスクを必要としないのできわめてシンプルです。

サーバー内のテキストデータ*str_send="test"をブラウザに送信して表示させる場合で確認していきます。

4文字テキストを送信する場合はマスクは使用せず、WebSocketデータフレームの1番目と2番目バイトブロックに送信するデータのフォーマットを指定して、つづいてテキストデータを送信するだけです。

HTTPプロトコルに比べて送信時は特にヘッダが小さいため送信する情報量が小さくてすむのが特徴です。送信データが小さいものほど差は顕著です。

ブラウザへはTCPのsend関数(TCP処理系により異なる)で送信します。

ブラウザではデータを受信したときにonmessageイベントが発火しますので、テキストを表示させるなど実施したい処理を設定しておいてください。

これらの送信ブロックを任意のタイミングで送信してブラウザに反映させることができるのがWebSoketの特徴です。

これまでの内容を実機で確認する場合の配線はこれまでと同じです。

ブラウザからサーバーのIPアドレス/ポートを指定するとボディメッセージに記述したHTMLページが開きます。

WebSocketコネクションを確立するために"Connect"ボタンを押します。このサンプルでは”Connect"ボタンを押してからWebSocketリクエストを送っています。

WebSocketコネクションが確立すると発火するopenイベント内に"Websocket Connectioned!!"を表示するようにしています。

HTMLのスライダーを操作するとJavaSriptで設定したデータ範囲の数値が"Slider output"に表示されます。これはブラウザ側で生成した値で送信するデータですのでWebSocketコネクション確立にかかわらず表示されます。

WebSocketコネクションが確立した状態でスライダーを操作すると同時に"NUCLEO Loopback"に数値が表示されます。これはサーバーが受信したデータをそのままブラウザに送り返しているデータですので双方のデータはほぼリアルタイムに連動しているところがWebSocketによる双方向通信の特徴です。

"Close"ボタンを押すとcloseメソッドを実行してコネクションを切断するようになっています。Closeイベントが発火すると"Websocket DisConnected.."を表示するようにしています。

ひとたびWebSocketコネクションが確立するとWebsocketプロトコルによる双方向通信は比較的シンプルに実現できます。ただ、実際の運転においてはTCPソケット通信に比べて通信が不安定になりがちですので安定した通信を実現するにはあと一工夫必要です。

次のデモ動画はサーバー内の変数をブラウザに送って表示させるものです。送信のサンプリングレートは100msです。

これくらいの表示速度であれば動作を伴うセンサー値などのリアルタイムモニターに応用できるのではないでしょうか。

送信周期を100ms以下にすると不安定で、組み込み機器のリアルタイム通信としてはこの速度では少し物足りずWebSocketの利点が活かされていないようですが、現状ではこんなものかもしれません。フリーズや切断する原因を特定して可能であればより安定して高速な通信の実現を今後の課題としておきます。

これに関しては解説記事が世に溢れているため、詳細解説はここではあえてしません。マイコンでWEBサーバーを構成するにあたってつまずきやすいポイントにしぼって最低限必要な知識の要点をまとめるように努めています。

HTTPはTCPの上位にあるプロトコルでHTTPリクエストとHTTPレスポンスと呼ばれるHTTPメッセージでやり取りしているのですが、目に見えない水面下ではTCPによるデータ通信を行っています。

通常、WEBサーバーはファイルシステムをもっているコンピュータシステムにHTMLで記述したページ、CGIプログラム、さらに画像ファイル等を保存しておき、クライアントからの指示に従ってページを渡したり、プログラムを実行したりブラウザへ応答するものです。

対して、ファイルシステムを持たないマイコンの場合はサーバーは個々のファイルが作成できないために、かわりにすべてのデータを静的な文字列にコード化(ハードコーディング)して配列に格納して文字列の送信でブラウザに表示させます。　

ファイルシステムがないサーバーは画像ファイルが扱えないために、見た目のシンプルな簡易的なものに限られますが、最低限の機能でもブラウザからマイコンにアクセスできてリモート管理等できることは大きな意義があります。

HTTPはWEB専用でブラウザとサーバの間でやりとりするプロトコルです。クライアントであるブラウザがリクエストメッセージ(要求メッセージ)をだしてWEBサーバーはレスポンスメッセージ(応答メッセージ)を返します。

HTTPプロトコルはテキストで記述したヘッダーを送受信したいデータに加えたフォーマットになっています。

下のコードはアクセスしたいWEBサーバーのURLをブラウザから入力したときのリクエストメッセージです。一行目はリクエストラインでメソッドGETから始まりアクセスしたいURL等が続きます。

ついでメッセージヘッダでブラウザの情報を伝えています。このリクエストにはデータはありませんのでボディーは空です。

上記コードはGETメソッドでURLが192.168.3.100:50000へのアクセスリクエストです。 URLにはアクセスしたいファイルのパス名まで入れることもありますが、省略したときはトップページのHTMLを要求していることになります。

HTTPプロトコルの規定ポート番号80以外の場合にはポート番号を明記します。

HTTPレスポンスにはWEBサーバーの情報を記述します。ヘッダ項目でHTMLで記述したページを送りたい場合はContent-Typeにtext/htmlとします。次のContent-Lengthはメッセージボディのデータ長を指定します。これらの設定はブラウザに内容を正しく表示する上で重要です。

メッセージボディはHTMLで記述したページ等の内容です。上記のコードはマイコンからブラウザへHTMLをコード化(ハードコーディング)した文字列を送信した内容でファイルシステムでのHTMLファイルを送るのと同じものになります。

ブラウザからの入力フォームで送信ボタンにGETメソッドを指定(method="get")しています。

HTTPメソッドとはクライアントがWEBサーバーに要求する処理のことで、数種類ありますがブラウザとマイコンとのやり取りでは主にGETメソッドとPOSTメソッドの2種類を扱います。

ブラウザがサーバーからHTMLファイルなどを取得する場合にはGETメソッドを、ブラウザからサーバーにデータを送信する場合はPOSTメソッドを使います。GETメソッドはPOSTメソッドのようにデータ送信にも使えますが、その場合はURLの後ろにデータを付けて送信します。

標準的なGETメソッドの用法です。ブラウザ(クライアント)はWEBページのURLを入力するとまずはじめにサーバーへTCP接続を要求します。

サーバー側がクライアント側からのTCP接続要求を受け入れて接続(コネクション)が確立するとHTTPプロトコルでのやり取りがはじまります。

ブラウザはGETメソッドリクエストラインから始まるリクエストメッセージをサーバーに送信します。

サーバーはGETリクエストを受けて次のレスポンスを返します。

ブラウザはGETリクエストの内容によりHTMLページを開いたり、指定されたファイルにアクセスします。

GETメソッドを使ったデータ送信フォーマットです。ブラウザのアドレス欄にURL末尾に「?」をつけて「データ=xxx」を送ります。

サーバーは下記のようなフォーマットでリクエストメッセージを受信データとして取得できますのでメソッド「GET」とデータ「ABC」を処理して抽出すればよいだけです。

GETメソッドによるデータの送信はとても簡単な方法ですが、URL欄に履歴が残るために機密データを送信するには問題があります。

基本的にデータの送信にはPOSTメソッドを使います。GETメソッドとは違いブラウザの履歴は残りません。

サーバーは下記のようなフォーマットでリクエストメッセージを受信データとして取得できます。データはリクエストヘッダが終了した空行のあとのボディにあります。

リクエストすべてを受信してからのメソッド「POST」とボディ内のデータ「ABC」を処理して抽出することになるため、「GET」のときに比べて受信データ量は大きなものになります。

WEBサーバーを搭載してもプログラムの基本的な流れはTCPサーバーの時とあまり変わりません。送受信データにHTTPプロトコル特有の多少の尾ひれがつくのでその処理が追加になります。

STM32マイコンにWEBサーバーを搭載したプログラム概要です。HTTPプロトコル特有の内容はモジュールhttp_server.cに記述しておき、ヘッダファイル http_server.h を読み込んでおきます。

ここではサーバー内でのデータをブラウザで表示するデモ用プログラムとしてRTOSのタスクprvTask_monitorを一つ追加してその中でデータ値を１秒間に１カウントアップしています。

下のWEBサーバーモジュールは今回のデモ用WEBサーバーの中核となる部分です。ブラウザでURLを入力して起動するトップページは配列top_document[]の内容です。GETメソッドリクエストにデータが含まれない場合のページです。

送信した文字列があらかじめ設定した文字列"ABC"と一致したときと不一致のときのメッセージを表示する別ページは配列top_document2[]の内容です。GETメソッドリクエストにデータが含まれる場合のページです。

HTMLファイルをコード化して配列に格納するにあたって最も重要なポイントは変化のない静的なコードと内容により異なるコード長データ"len_top_document"など動的なコードをsprintf関数で結合しているところです。これを利用すると静的なファイルであるはずのHTMLが動的な要素を含んだページになります。

ブラウザからのリクエストメッセージにはGETやPOSTなどのメッセージおよびデータが含まれていますので、それらをまず正確に抽出する処理が必要です。これらはタスクprvTask_TCP内で処理を行っています。

今回のデモプログラムではデータ送信にGETメソッドを使用しているために「GET」をコマンドとして受信した場合にリクエストがデータなしかデータ付きかで処理を分岐しています。

Nucleo-F103RBにWEBサーバーを搭載したところで実際にブラウザにURLのIPアドレスとポートを入力してアクセスしてみます。

URLを入力するとサーバーとのコネクションが確立して以下のページに切替わります。配列top_document[]にコード化した内容です。 左下の数値はマイコン内で１秒毎にカウントアップしているデータを表示したものです。現在値を確認するにはブラウザを手動で更新します。

以下のフォーム画面で文字を入力してGETメソッドでサーバーに送ります。文字"ABC"を入力して送信ボタン(Send)を押します。このボタンはGETメソッドに設定しています。

送信ボタンを押すとブラウザのアドレス欄にURL/?cmd=ABCが自動的に入り、ページが配列top_document2[]に格納したHTMLページに切替わります。入力した文字が“ABC”と一致すると下記のメッセージが表示されます。

今度は"abc"を入力して送信ボタンを押すとブラウザのアドレス欄にURL/?cmd=abcが自動的に入り、ページが切替わります。入力した文字が“ABC”と不一致であると下記のメッセージが表示されます。

以上、ブラウザからマイコンにアクセスして文字列を送信する様子とマイコンからのデータを表示することを確認しました。このデモプログラムは、機能は単純ですがこれらを自由自在に扱いこなせるとマイコンをブラウザからリモート管理することができる重要な要素を納めていますので是非実践してみてください。C言語で文字列を扱うトレーニングにもなります。

インターネット情報には無数の解説記事が存在するためにここでは詳細の解説は割愛しますが、簡潔にまとめますとソケット通信はサーバーとクライアントが互いに確認しながら通信を行うTCPプロトコルに基づいた方式です。互いにやりとりすることからハンドシェイク方式とも呼ばれます。

ソケット通信は電話による会話に似ていて会話の出入り口である受話器、耳、口に相当するものをソケットと呼びます。相手が応答して初めて会話(通信)が成立し、途中で相手やこちらで切断すると会話も終了します。また、相手が接続中(受話器を上げたままの状態)のときは、こちらからの接続要求に応答しません。

トランスポート層に属するプロトコルには他にUDPがありますが、これはサーバーがクライアントに確認せずに一方的に情報を与える方式です。動画などのストリーミングで内容に多少の不備があっても問題がない多量の情報を送るのに適しています。

下図はソケット通信で標準的なバークレーソケット（BSD unixに実装されたネットワーク用API）に基づいた通信のフローチャートです。サーバー、クライアントともにあらかじめソケットを作成しておき、クライアント側から必要時に接続要求をだして、サーバーが応答して通信を確立します。一度確立すると、どちら側から切断しないかぎり、任意のタイミングで送受信できるのがソケット通信の特徴です。

ドライバsoket.cでは標準インターフェースのBSDソケットに準じた関数をまとめていますがここではドライバ内に定義された関数の一部のみを使用したソケット通信のサンプルを紹介しています。

サンプルプログラムではTCPサーバーをサンプリングタイム5msで実行する専用タスクprvTask_Tcpに構成しています。

ドライバのソケット標準関数を使用して一般的なTCPサーバーを作成することもできますが、ここではサンプリングタイム毎にモニターしたソケット状態に応じた処理をドライバのレジスタ操作関数を使って実行します。

ソケットの状態は主に
「SOCK_CLOSED」ソケット閉鎖
「SOCK_LISTEN」ソケット待機
「SOCK_ESTABLISHED」ソケット確立
「SOCK_CLOSING」ソケット閉鎖中
の4種類があり、これらの状態をソケット番号SNに応じてgetSn_SR(SN)関数でソケットのレジスタ値を読み込みます。

プログラム起動直後のソケットは「SOCK_CLOSED」ですのでまずソケットをsocket()関数で生成します。

関数の第1引数はソケット番号SNで、SNは自作関数をまとめたヘッダファイルnet_conf.hで1に定義しています。

第2引数はプロトコルは設定でTCPプロトコルを指定しています。第3引数はPORT番号を指定し、第4引数ではnon-blockを指定し、ノンブロッキングソケットとしています。

ソケットが作成されるとlisten(SN)関数を実行し、SOCK_LISTEN状態に遷移してクライアントからの接続待ち状態で待機します。

ソケットの状態がSOCK_LISTENの待機時にクライアントのターミナルからIPアドレスおよびポートを指定して接続の要求をし、接続が確立するとSOCK_ESTABLISHEDになります。接続が確立しクライアントのターミナルにサーバーのIPアドレスが表示されると任意のタイミングで送受信ができるようになります。

データ受信にはrecv関数を使用します。第1引数はソケット番号、第2引数は受信バッファのポインタ、第3引数はデータ長を指定します。データを受信するとデータ長を返します。

データ送信にはsend関数を使用します。第1引数はソケット番号、第2引数は送信バッファのポインタ、第3引数はデータ長を指定します。

通信用バッファメモリである送信TXおよび受信RXバッファはそれぞれ16Kバイトのブロックで構成されています。

setSn_CR関数はsocket.c内に定義されている関数でソケットを制御するものです。第1引数はソケット番号、第2引数はソケットの状態を指定します。Sn_CR_CLOSEを指定するとソケットを閉鎖(close)します。

その他ソケットの”OPEN", ”LISTEN", "CONNECT", "DISCON", "SEND", "SEND_MAC", "SEND_KEEP", "RECV"等があります。詳細はドライバのソケット定義ファイルsocket.cを確認してください。

TCPサーバーのソケット状態遷移をまとめると上図のようになります。W5500ではソケット状態は他にもありますが、とりあえず主な4つの状態をコントロールしておけば機能します。

ソケット通信の状態を電話による会話に例えると下図のようなイメージなります。この通信状態を想定しながら実際にソケット通信を実施して動作を確認してみます。

クライアントではターミナルソフトを使用します。ここでもTera Termを使用しています。これに限らず慣れたツールを使用してください。

起動後、TCPソケット通信ですのでサーバーに登録したIPアドレスおよびポート番号を入力し"OK"を押します。

画面左上にサーバーのIPアドレスが表示されると設定ポートが開いてクライアントとサーバーが接続したことになります。

TCPサーバーに対してコマンドを与えて通信できるかを確認します。通信テスト用の応答メッセージを返す処理、ソケットの閉鎖(close)および接続切断(disconnect)するコマンドをまとめたファイルを作成して実行しています。

まず文字列"ABC"を入力します。受信バッファに格納された文字列が"ABC"で一致すると”Matched‼"と応答します。応答はsend関数を使用しています。

文字列"abc"を入力すると"ABC"と一致しませんので”Error"と応答します。

ソケットが接続確立しているところで新たに別の接続を試みます。

すでにポートが開いているために接続が拒否されました。電話では相手の受話器が上がっていて話し中の状態です。

ソケットを閉じるためにコマンド"scls"を入力すると"socket close"メーセージを返してCRレジスタにSn_CR_CLOSEを送信してからソケットを閉鎖(close)します。結果、未接続となります。

また新たに接続を試みると今度はソケットが閉じているため再びポートが開き接続できます。

最後に接続自体を遮断するため、コマンド"srst"を入力します。CRレジスタにSn_CR_DISCONを送信し、切断処理(disconnect)を実行します。

画面左上が未接続となり接続が遮断されたことが確認できます。

以上、テスト用コマンドを入力してソケット通信の様子を確認しました。実際のソケット通信ではプログラミング次第でコマンドをさらに多様化してコマンドにより様々な処理を実施させることになります。

TCPソケット通信はサーバーとクライアント間でリアルタイムでデータをやりとりできることが特徴ですので組み込み機器にTCPサーバーを搭載しておけばIoTとしてリアルタイムでインターネットを介してデータのリモート管理ができるようになります。

ネットワークには様々な規格の装置・機器が接続されているのですが、ネットワークの規格は以下のOSC参照モデルで共通化されていますのでどのような装置・機器でも共通規格であれば通信できるようになります。

イーサネットは有線LANの一つで最も普及している規格でありIEEE802.3で定義されたものです。

規格に従って、物理層のLANケーブルから例えばウェブブラウザを使用したHTTPアプリケーション層までの通信システムを構築することになります。データリンク層までは大抵ハードウェアで構成され、それ以降はソフトウェアで構成されます。

イーサネット通信に関してマイコンを大別すると3種類あり、下記のように分類できます。

1番めの汎用マイコンはイーサネットコントローラが非搭載ですのでMAC/PHYデバイスコントローラを外付けして汎用バスであるSPI、I2Cなどをインターフェースとして通信を行います。今回扱うNucleo-F103RBのマイコンはこれに当たります。

２番めのマイコンはイーサネットMACデバイスを内蔵したもので例えばSTM32F407がこれに当たります。PHYデバイスコントローラを外付けしてマイコン内蔵のMACデバイスとMII/RMIIとよばれる方式で通信を行います。

３番めのマイコンはイーサネットに必要なデバイスMACおよびPHYを内蔵したもので、追加部品はパルストランス内蔵のRJ-45のみです。

マイコンと組み合わせてイーサネット対応にするコントローラで一般的に使用されていて取得性のよいものを紹介します。

イーサネットの知識がなくてもWiFiのときに使用したESP32のように汎用シリアル通信をインターフェースとしたコントローラでシリアル通信感覚で使用できます。

最も簡易的なIoT対応コントローラとして選択できます。シリアル通信のみ対応の既存の機器に外付けするだけなのはメリットですが、メーカー提供のドライバに従うため汎用性が高いとはいえないことと、既存の製品に組み込むのは他の手段に比べコスト的に採用しにくいことがデメリットです。

ENC28J60コントローラはイーサネットコントローラ非搭載のマイコンでもSPI通信を持っていればイーサネット対応にできます。

TCP／IPプロトコルスタックを自分で組み込まなければなりませんのでSTM32F1シリーズでは実施例の資料が少なく大変そうです。移植するには選択したTCP/IPプロトコルスタックの中身を理解する必要がありますが、そこに時間をかけたくない場合は次のW5500がおすすめです。

ENC28J60コントローラの場合と同じくイーサネットコントローラ非搭載のマイコンでSPI通信を持っている場合に適用できます。両者の大きな違いはW5500はTCP/IPプロトコルスタックをハードウェアに内蔵していることで搭載のわずらわしさがなくコネクションが安定しています。

そのため、TCP/IPプロトコル・スタックについての知識がなくても使用できることに加え、ソフトウェア負荷が小さいのでメモリの小さなマイコンに搭載できることも大きな利点です。

Nucleo-F103RBのSTM32マイコンに対して外付け部品も少なくてすみ、TCPプロトコルを利用したソケット通信やさらに上位のHTTPプロトコルを利用したブラウザからの通信にも発展できるバランスのとれたコントローラです。

STM32F407マイコンのようにイーサネット対応MACを内蔵したものにはPHYデバイスのみを持つLAN8720やDP83848等のコントローラがよりマイコンの機能を活かせます。

上位機種であるCortex-M4コアを内蔵するSTM32F407を新規に採用する場合はもはやライブラリはSPLにこだわるのではなくHALやLLドライバを使用したほうが手っ取り早いです。

開発環境STM32CubeIDEを使用すれば開発プロジェクトを作成する段階で自動生成機能を利用するとTCP/IPプロトコル（LwIP）も簡単に組みこめ、トランスポート層のTCPやUDPプロトコルまで実装できてしまいます。

はじめからネットワーク機器向け製品を設計する場合はネットワーク内蔵のマイコンを選択するのが良いのではないでしょうか。

イーサネットコントローラ非搭載のマイコンSTM32F1シリーズでイーサネット対応にするには汎用性を考えるとW5500かENC28J60あたりになります。

TCP/IPプロトコルスタックをハードウェアに内蔵しているW5500はとりわけネットワーク仕様としての性能は申し分なく気軽にマイコンをネットワーク化対応にできるためこちらを選択することにします。

TCP/IPプロトコルスタックについては規格に準じたものなので内部詳細をあえて理解する必要性はあまり感じられず既成のモジュールとして割り切ってもよいのではないでしょうか。

外付けでW5500でNucleo-F103RBをネットワークにつなげるにはここでは市販W5500ボードを利用します。ボードは安価で最低限の周辺部品が備わっていますがMACアドレスがないボードも多いです。

製品開発をする場合にはこの市販W5500ボードに使用されている最低限の周辺部品の他にMACアドレスを保持するためのEEPROM等メモリが必要になります。

Nucleoとの接続は割り込みや外部リセットを使わないのであれば電源とSPI通信部のみで機能します。リセットはソフトウェアで実行するのであればなくても機能はしますがW5500はパワーオンリセットではないので、リセットの確実性を高めるため特に製品化の場合にはハードウェアリセットは使用すべきです。今回はSPI2を使用するため下図のような接続になります。

W5500はIC内部のレジスタをSPI通信で操作して通信を行います。レジスタの詳細はW5500データシートに詳細が記載していますが、プログラミングにおいてはメーカーが提供するドライバ類をライブラリ(ioLibrary_BSD)として登録しておき、必要に応じて関数類を呼び出して使用します。

STM32マイコンとのSPI通信のインターフェースにあたる関数をまとめたファイルがwizchip_conf.c/wizchip_conf.hです。このファイルでは使用するコントローラICチップ(W5500)の指定や、レジスタアドレス等が登録されています。マイコンとのインターフェースカスタマイズで一部修正する必要はあります。

w5500.c/w5500.hはコントローラW5500で使用するマイコンとの送受信関数を定義してまとめたものです。

socket.c/socket.hはTCPソケット通信で使用する関数群をまとめたものです。バークレーソケット(BSDソケット)に準じた関数となっています。

これらを最低限ドライバとしてioLibrary_driverフォルダ内に登録しておき、他はDHCPに関するものなど必要に応じて追加するのが良いと思います。

LANコントローラW5500には書き込み/読み込み等の操作、IPアドレス等パラメータ、プロトコル指定など仕様を設定するためのコモンレジスタブロック、およびソケット通信で使用するソケットレジスタブロックがあります。

レジスタの詳細はW5500の取説に解説しており、かなりきめ細かな設定ができるようになっていますが、一般的な用途では使用するのは一部だけです。

これらのレジスタブロックを操作するためにSPI通信をインターフェースとしてマイコンとやり取りしますのでこの部分を確立できればほぼできたようなものです。

ドライバのインターフェースのファイル（ｗizchip_func.ｃ)に手を加えてSTM32マイコン仕様にするのはほんの一部だけです。実際のプログラミングにおいてはドライバ内で定義した関数が使用できますので一度ポイントを理解してしまえば手間はほとんどかかりません 。

実際にどのような仕組みでレジスタを操作しているかを一度は取説を見ながらドライバ内の関数を順に追ってみるのがよいと思います。

W5500でのspi通信のフレームフォーマットでは1バイト(8ビット)ごとのブロックで下図に示す３フェイズで構成されます。上位・下位２バイト分のアドレスフェイズ、１バイトのコントロールフェイズ、そしてデータフェイズです。

STM32マイコンで定義するSPI関連の関数（チップセレクト、送受信）をW5500ドライバに紐付けるためのカスタマイズです。

SPIインターフェース(ｗizchip_conf.c)で下記の赤色で囲った部分を追加登録します。チップセレクト関数SPI_CS1_Select()/ SPI_CS1_Deselect() はSTM32Nucleo用に自作したものです。

自作した送受信関数SPI_Send_Receive() も同様に追加登録します。

内容が異なる場合は上図で追加定義したSPI送受信関数を下図のようにドライバ定義の関数に紐付けします。

実際、ドライバに追加したり、書き換える重要な部分はこれだけです。その他、ビルドの際にそのままではエラーとなりますがインクルードするファイルパスを修正すればよいだけです。

自作したSPI関連関数を定義したファイルをSPIインターフェース(ｗizchip_conf.c)のヘッダファイルにインクルードさせてリンクできるようにするのを忘れないでください。

SPI通信でのインターフェースが準備できたら実際のプログラミングではドライバ内で定義している関数を利用して初期設定をします。.

初期化フローチャートはプログラム内では下記のようにW5500_ini()関数にまとめています。レジスタ操作するための関数はドライバのヘッダファイルW5500.hで定義しています。

W5500はマルチキャストなど高度な設定もできますがここでは簡単なシングルキャストの基本設定で初期化をします。

レジスタのリセット(MR_RST)発行を行い、PHY初期化、送信元(サーバー側）のMACアドレス、IPアドレス、そしてKeepAlive,タイムアウト等を登録します。

これまでの初期設定を完了させるとネットワーク層までの通信環境が整ったことになります。プログラム全容は下記のようになります。

初期化関数W5500_ini()やネット関連の自作関数等は別途モジュールnet_func.cにまとめていてそのヘッダファイルをインクルードしています。

プログラムを実行させると、設定したIPアドレスに属するネットワークアドレスをもったLANに接続することができます。

ここではネットワークアドレスが192.168.3でIPアドレスを192.168.3.100に設定しています。

PCのコマンドプロンプト画面から「ping」コマンドを実行してネットワーク内で認識されているかを確認します。 "ping 192.168.3.100"と入力した場合の応答を確認します。

下記のような画面の場合は何らかの原因で不備がありpingが通っていない状態を示しています。

このような場合は大抵、ケーブルに不備があったり設定したIPアドレスと異なったものを入力していたり何らかの原因があります。

プログラミング直後の初接続時にping応答がこのような場合はプログラムに何らかの不備がある可能性があるため、バグの原因を突き止めることになります。特にspi通信関連の動作確認とドライバ関連ファイルのパスは大切です。一度機能すれば大丈夫です。

プログラムが正常に機能すると下の画面が現れます。この状態ではpingが通っているため、無事ネットワークに参加することができたことを示しています。

pingコマンドはICMPプロトコルのものなのでOSI参照モデルのネットワーク層まで通信システムが確立したことになります。

pingコマンドだけでは通信チェック以外には何の仕事もできないのですが、ここまでのネットワークを確立できると、あとは上位のTCPプロトコルによるソケット通信やさらにその上位のHTTPプロトコルを搭載してwebサーバーを作成してブラウザからアクセスできるようになります。

今回はIPアドレスはメモリに保存した固定値"192.168.3.100"を使用しています。ここでは解説しませんが、DHCP機能を搭載するとDHCPサーバーから自動的に割り当てられたIPアドレスを使用できるようになります。

次回は上位プロトコルであるTCPを実装してソケット通信を実現します。