This is an old revision of the document!
OpenWRT 17.01.x with MESHdesk packages
Follow these instructions to build the MESHdesk firmware on devices capable of running OpenWRT version 17.01.x
Minimum Hardware Requirements
The minimum hardware requirements are:
Although the system can potentially support hardware with less resources, supporting them in 2021 is not practical any more.
The hardware does not need a radio on it.
Hardware without radios can be managed using APdesk.
Mediatek and Atheros / Qualcomm SOC devices are supported.
Other target systems are also supported but have not been thoroughly tested to date.
If you are not sure if your hardware will work please visit the OpenWRT website and check. They have an ever growing list of supported hardware.
Next we will look at the steps you need to take to get MESHdesk working with it.
Steps In Adding New Hardware
The Very First Time (Draft)
These steps you have to do ONCE ONLY
Build OpenWRT with MESHdesk firmware (MESHdesk disabled).
Flash your device.
Prepare the wan_network file for specific device.
Prepare meshdesk config file for specific device.
Prepare captive_config.json file for specific device.
Afterwards (Final)
Build OpenWRT with MESHdesk firmware containing the device specific files for
wan_network
captive_config.json
meshdesk
Flash your device with the final built of firmware.
So without further ado, lets get going with the first draft built.
In this page we will take an Open Mesh OM2P (first version) Access Point as a sample unit.
You can use the hardware of your choice and simply apply the same principles.
Make sure you followed
these instructions to prepare the environment.
Fetching the MESHdesk package
#Do this in the working directory e.g. cd 17.01.7
git clone git://git.code.sf.net/p/radiusdesk/openwrt-meshdesk openwrt-meshdesk
zzz-MESHdesk - This is the MESHdesk package which will be build by the SDK.
files - This is the override structure containing files to override during the build process.
luci-app-meshdesk - This is the Luci application used to enable central control.
Copying the three components
#cd to the working directory
cp -R ./openwrt-meshdesk/zzz-MESHdesk ./openwrt/package
#cd to the working directory
cp -R ./openwrt-meshdesk/files ./openwrt
#cd to the working directory
cp -R ./openwrt-meshdesk/luci-app-meshdesk ./openwrt/feeds/luci/applications
Updating the available packages
Since we added a Luci application, we need to tell the SDK about it.
After you copied the packages across issue the following command:
#cd to the working directory
cd ./openwrt
scripts/feeds update -i
#Install the package to make it visible
scripts/feeds install luci-app-meshdesk
These instructions are for the 17.01.x branch.
Each branch has a unique set of small tweaks in its instructions.
If you are using a different branch please refer to that branch's page
Select Packages To Include With Firmware
Select the following packages when building the firmware.
Package names in bold are required.
The Mosquitto packages are for MQTT support.
The Batman packages are for mesh support.
Package | Location | Comment |
zzz-MESHdesk | Base system | |
kmod-batman-adv | Kernel Modules → Network Support | Keep the default options |
lua-mosquitto | Languages → Lua | |
libiwinfo-lua | Languages → Lua | |
luasocket | Languages → Lua | |
libuci-lua | Libraries | |
luci | Luci → Collections | |
luci-app-meshdesk | Luci → Applications | Luci App to enable and disable central management |
luci-theme-material | Luci → Themes | Modern theme that is easy to customize |
luci-lib-httpclient | Luci → Libraries | |
luci-lib-json | Luci → Libraries | |
luci-lib-jsonc | Luci → Libraries | |
coova-chilli | Network → Captive Portals | Select OpenSSL as SSL Library Do not include to save space eg on OM2P |
curl | Network → File Transfer | |
relayd | Network → Routing and Redirection | |
batctl | Network | |
mosquitto-client-ssl | Network | Note the CLIENT package |
wpad IEEE 802.1x Auth/Supplicant (built-in full) | Network | Use default wpad-mini to save space eg on OM2P |
After you selected these packages you can save the configuration and issue make to build the firmware.
The firmware you just built will be standard OpenWRT in effect and you can flash your hardware as with normal OpenWRT then access it on 192.168.1.1.
The next section will cover the files you have to attend to for the specific hardware tweaks.
Initial File Preparation
wan_network
- network
config interface 'loopback'
option ifname 'lo'
option proto 'static'
option ipaddr '127.0.0.1'
option netmask '255.0.0.0'
config globals 'globals'
option ula_prefix 'fd15:97e0:cb63::/48'
config interface 'lan'
option type 'bridge'
option ifname 'eth0'
option proto 'static'
option ipaddr '192.168.1.1'
option netmask '255.255.255.0'
option ip6assign '60'
config interface 'wan'
option ifname 'eth1'
option proto 'dhcp'
config interface 'wan6'
option ifname 'eth1'
option proto 'dhcpv6'
With this setup we have the POE port as
LAN (The port next to the Power Jack).
We also have the WAN sitting next to the antenna.
This is not ideal for us since we want to feed power onto the WAN port.
Next look at the /etc/MESHdesk/configs/wan_network file that is derived from it.
- wan_network
config interface 'loopback'
option proto 'static'
option ipaddr '127.0.0.1'
option netmask '255.0.0.0'
option ifname 'lo'
config interface 'lan'
option ifname 'eth0'
option type 'bridge'
option proto 'dhcp'
config interface 'client_0'
option proto 'dhcp'
config interface 'client_1'
option proto 'dhcp'
Note there are no switch sections. Please refer to the other Wiki pages on the convention to use if the network file has switch sections.
client_0 and client_1 interface sections can always be kept as is.
lan interface section is in actuality the WAN port. (This is due to the historical nature of the project and also that we support hardware with a single Ethernet port)
Since we wanted the port with POE (eth0) as WAN we actually kept the membership of the lan interface as is (remember it is actually the WAN port)
Next we will look at the /etc/config/meshdesk file and tweak it to work with our environment and our hardware.
There is a growing list of existing sample wan_network files under the /openwrt/package/zzz-MESHdesk/files/MESHdesk/configs folder.
They have a convention of network_<firmware_id> e.g. network_xiaomi_4a_100
Simply copy that file over openwrt/package/zzz-MESHdesk/files/MESHdesk/configs/wan_network
Those files will have a matching existing hardware section in the openwrt/package/zzz-MESHdesk/files/MESHdesk/meshdesk file
meshdesk
Tweaks For Our Hardware
#change directory to where the LEDs are
cd /sys/class/leds/
ls
#These are the LEDs available
blue:power mt76-phy0 mt76-phy1 yellow:power
#turn it off
echo "0" > yellow\:power/brightness
#turn it on
echo "1" > yellow\:power/brightness
#turn it off
echo "0" > blue\:power/brightness
#turn it on
echo "1" > blue\:power/brightness
In our case we can use the yellow LED to light up if the comms to the controller is broken.
We can use the blue LED to signal during startup and neighbor counts.
There is no extra LED so we will not define one for the mesh traffic.
With this info we can create a hardware section in /etc/config/meshdesk
config hardware 'xiaomi_4a_100'
option morse_led '/sys/class/leds/blue:power/brightness'
option internet_led '/sys/class/leds/yellow:power/brightness'
option wifi_led 'led0'
config settings 'settings'
option hardware 'xiaomi_4a_100'
option id_if 'eth0'
option lan_up_file '/tmp/lan_up'
Don't make the name of the hardware section more than 14characters. Longer names break things during deployment.
Later we will also use the value of xiaomi_4a_100 to define the hardware on the controller.
The final tweak for the hardware in the config file is the interface that must be used as the id_if.
Since we want the yellow LED to be off when the comms to the controller is fine we need to check what the current setup is
vi /etc/MESHdesk/reporting/report_to_server.lua
#Look for this section
if(ok_flag)then
internetLED('0'); -- NOTE Here we can swap thme around eg make it 0 to turn off a red LED when the internet is OK
checkForContollerReboot('1');
else
internetLED('1');
checkForContollerReboot('0');
end
Item | Typical value | Comment |
settings → hardware | xiaomi_4a_100 | Must match a hw definition in the file itself |
settings → id_if | eth0 | eg eth0, eth1 or wan - NOT eth0.1 (for those boards its just eth0) |
settings → skip_radio_0 | 0 | set to 1 when radio0 is a 5G radio and you don't want to use it for config SSID |
Tweaks For Our Environment
Item | Typical value | Comment |
internet1 → disabled | 1 | change it to 0 in order for the device to be centrally controlled |
internet1 → dns | cloud.radiusdesk.com | Supply Dummy Value If Not Using DNS System |
internet1 → protocol | https | Can be http or https |
internet1 → ip | 176.31.15.210 | Fallback when FQDN does not resolve on FQDN not used |