diff --git a/README.md b/README.md index 26a306c..641606f 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,59 @@ -Odin Wi5 Agent -============== +**Note**. You will find detailed information in this wiki: https://github.com/Wi5/odin-wi5/wiki -We are adding interesting info in this wiki: https://github.com/Wi5/odin-wi5/wiki +Odin agent +========= -Odin Wi5 agents run on physical APs, and are implemented as Click elements. Agents contain the logic for the Wi-Fi split-MAC and LVAP handling. Agents also record information about clients using Radiotap headers, and communicate with the Odin Controller over the Odin control channel. The physical AP hosting the agent also requires a modified Wi-Fi device driver to generate ACK frames for every LVAP that is hosted on the AP. +Odin agents run on physical APs, and are implemented as Click elements. Agents contain the logic for the Wi-Fi split-MAC and LVAP handling. Agents also record information about clients using radiotap headers, and communicate with the Odin Master over the Odin control channel. The physical AP hosting the agent also requires a slightly modified Wi-Fi device driver to generate ACK frames for every LVAP that is hosted on the AP. Source files for Odin agent: src/odinagent{.cc,.hh} ----------------------- +----------------- -These are the Click OdinAgent element files. They have only been tested in userspace mode. +These are the Click OdinAgent element files. They've only been +tested in userspace mode so far. To build: -To build, follow the instructions in https://github.com/Wi5/odin-wi5/wiki/Cross-compiling-Click-Modular-Router-for-Odin +1. Add these files to /elements/local/ -You also have a binary version of Click, cross-compiled for AR71xx architecture https://github.com/Wi5/odin-wi5-agent/tree/Handover_Improvement/click_binary_file - -A `click-align` binary is also available, compiled for the same architecture. +2. Build Click with the `--enable-local` and `--enable-userlevel` flag. +3. ``` $ make``` agent-click-file-gen.py ----------------------- -This is the `.cli` file generator for the agent. Configure and use this script -to generate the appropriate Odin agent Click file. +Click file generator for the agent. Configure and use this script +to generate the appropriate Odin agent click file. + +This is an example of how to use the python command: + + $ python agent-click-file-gen.py 4 50 14:CC:20:AC:72:91 192.168.1.129 2819 /sys/kernel/debug/ieee80211/phy0/ath9k/bssid_extra odin-unizar 192.168.1.7 0 11 12 25 0 + +where the parameters have the next meaning: + +`4` number of the channel + +`50` size of the queue + +`14:CC:20:AC:72:91` MAC address of the AP + +`192.168.1.129` IP address of the Controller + +`2819` port used to connect with the Controller + +`/sys/kernel/debug/ieee80211/phy0/ath9k/bssid_extra` directory of the debug file -This is the scheme implemented by the `.cli` file: it includes an auxiliary interface. +`odin-unizar` SSID -![scheme of the cli file](https://github.com/Wi5/odin-wi5/blob/master/pictures/diagram_Odin_Click_agent_2ifaces.png) +`192.168.1.7` IP address of the AP -If you run `$python agent-click-file-gen.py` you will see an example of how to use the python script, and the meaning of each parameter. +`0` No click debug info +`11` Debug level 1, with Demo appearance (1) -Scripts for starting the Odin Wi5 agent ---------------------------------------- +`12` 6 Mbps of TX rate -The script for starting the Wi5 agent are here https://github.com/Wi5/odin-wi5-agent/tree/Handover_Improvement/scripts_start_ap_odin +`25` the Tx power of the AP is 25 dBm (obtained with `$iw dev mon0 info`) -A script for debugging is also available. +`0 no hidden mode: the AP will respond to all active scanning requests, even if they have no SSID name