CONFIG

Last update: May 2018

The FlashAir can be controlled by changing /SD_WLAN/CONFIG. To activate changed settings, you have to restart the FlashAir by removing and re-inserting it. There are hidden attributes attached to this directory, therefore you need tools to handle this hidden folder. Please note that any setting changes made by config.cgi may take some time to be reflected in the CONFIG file. Restart the FlashAir, then change the CONFIG file. Regarding how to write CONFIG, please see CONFIG writing sample.

WLANSD

The following conditions allow us to controll Wireless LAN in common with iSDIO standard devices. For iSDIO specifications, please refer to SD Association .

Parameter Description Example Firmware Version
ID Card ID ID=SMITH’S_CARD 1.00.00+
DHCP_Enabled Enable DHCP Client DHCP_Enabled=YES 1.00.00+
IP_Address IP Address IP_Address=192.168.0.10 1.00.00+
Subnet_Mask Subnet Mask Subnet_Mask=255.255.255.0 1.00.00+
Default_Gateway Default Gateway Default_Gateway=192.168.0.1 1.00.00+
Preferred_DNS_Server Preferred DNS Server Preferred_DNS_Server=192.168.0.1 1.00.00+
Alternate_DNS_Server Alternate DNS Server Alternate_DNS_Server=192.168.0.1 1.00.00+
Proxy_Server_Enabled Enable Proxy Server Proxy_Server_Enabled=YES 1.00.00+
Proxy_Server_Name Proxy Server Proxy_Server_Name=yourproxy.com
Proxy_Server_Name=123.123.0.1
1.00.00+
Port_Number Proxy Server Port Number Port_Number=8080 1.00.00+

Vendor

The following conditions allow us to controll spcific to the FlashAir.

Parameter Description Example Firmware Version
APPAUTOTIME Set connection time-out period APPAUTOTIME=3000000 1.00.00+
APPINFO Application's unique information APPINFO=0123ABCD4567EFGH 1.00.00+
APPMODE Wireless LAN mode APPMODE=4 1.00.00+
APPNAME NETBIOS/Bonjour name APPNAME=myflashair 1.00.00+
APPNETWORKKEY Network security key APPNETWORKKEY=12345678 1.00.00+
APPSSID SSID APPSSID=flashair 1.00.00+
BRGNETWORKKEY Network security key for Internet pass-thru mode BRGNETWORKKEY=12345678 2.00.02+
BRGSSID SSID for Internet pass-thru mode BRGSSID=myhomelan 2.00.02+
CID Card ID CID=02544d53573038470750002a0200c201 1.00.00+
CIPATH Wireless boot screen path CIPATH=/DCIM/100__TSB/FA000001.jpg 1.00.00+
New COMMANDCGI 设置command.cgi的有效操作码 COMMANDCGI=100-103 3.00.00+
DELCGI Disable CGI DELCGI=/,/thumbnail.cgi 2.00.02+
New DHCPC_RETRANS_MAX DHCP client retransmission count DHCPC_RETRANS_MAX=5 4.00.03+
DNSMODE DNS operation mode DNSMODE=1 2.00.02+
New EAPCERT File path of TLS certificate EAPCERT=/cert.pfx 4.00.03+
New EAPPASSWORD PEAP password or TLS secret key password EAPPASSWORD=12345678 4.00.03+
New EAPTYPE Encryption standard EAPTYPE=TLS 4.00.03+
New EAPUSER User ID to use when EAPTYPE is specified EAPUSER=SMITH 4.00.03+
HTTPDBUFF Memory size HTTPDBUFF=2920 2.00.03+
HTTPDMODE Authentication method HTTPDMODE=1 1.00.04+
HTTPDPASS Authentication password HTTPDPASS=12345678 1.00.04+
HTTPDUSER Authentication user name HTTPDUSER=flashair 1.00.04+
IFMODE SD Interface User I/O enabled flag IFMODE=1 2.00.03+
LOCK Default configured flag LOCK=1 1.00.00+
LUA_RUN_SCRIPT Path to a Lua script to execute on boot LUA_RUN_SCRIPT=/bootscript.lua 3.00.00+
LUA_SD_EVENT Path to a Lua script to execute on a write event LUA_SD_EVENT=/writescript.lua 3.00.00+
MASTERCODE Mastercode MASTERCODE=0123456789AB 1.00.00+
NOISE_CANCEL Noise Cancel NOISE_CANCEL=2 2.00.03+
PRODUCT Product code PRODUCT=FlashAir 1.00.00+
REDIRECT HTTP redirect mode REDIRECT=1 2.00.03+
New STAMAC Address filtering function in STA mode STAMAC=40b395A0851a 2.00.02+
New STANUM Number of connected devices restriction function in STA mode STANUM=2 2.00.02+
STA_RETRY_CT Number of connection retries in STA mode STA_RETRY_CT=0 3.00.00+
TIMEZONE Timezone TIMEZONE=36 3.00.00+
UPDIR Upload destination directory UPDIR=/DCIM 2.00.03+
UPLOAD Upload operation enabled flag UPLOAD=1 1.00.00+
VENDOR Vendor code VENDOR=TOSHIBA 1.00.00+
VERSION Firmware version VERSION=F24A6W3AW1.00.03 1.00.00+
WEBDAV FlashAir Drive(WebDAV) enabled flag WEBDAV=0 3.00.00+
WLANAPMODE Wireless LAN Standard WLANAPMODE=0x03 3.00.00+

CONFIG writing sample

[WLANSD]

ID=SMITH’S_CARD
DHCP_Enabled=YES
IP_Address=
Subnet_Mask=
Default_Gateway=
Preferred_DNS_Server=
Alternate_DNS_Server=
Proxy_Server_Enabled=YES
Proxy_Server_Name=yourproxy.com
Port_Number=8080

[Vendor]

CIPATH=/DCIM/100__TSB/FA000001.JPG
APPMODE=4
APPNETWORKKEY=********
VERSION=FA9CAW3AW3.00.00
CID=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
PRODUCT=FlashAir
VENDOR=TOSHIBA

Card ID (ID)

Specifies card ID using ASCII 1 - 16 characters. Default is empty.

Example:

ID=SMITH’S_CARD

Enable DHCP Client (DHCP_Enabled)

Sets whether to enable or disable DHCP client as follows.

YES (Default) Enable DHCP client
NO Disable DHCP client

Example:

DHCP_Enabled=YES

IP Address (IP_Address)

When DHCP client is disabled, sets the IP Address. Default value is "0.0.0.0". When "DHCP_Enabled=YES", values are ignored.

Example:

IP_Address=192.168.0.10

Subnet Mask (Subnet_Mask)

When DHCP client is disabled, sets Subnet Mask. Default value is "0.0.0.0". When "DHCP_Enabled=YES", values are ignored.

Example:

Subnet_Mask=255.255.255.0

Default Gateway (Default_Gateway)

When DHCP client is disabled, sets the Default Gateway. Default value is "0.0.0.0". When "DHCP_Enabled=YES", values are ignored.

Example:

Default_Gateway=192.168.0.1

Preferred DNS Server (Preferred_DNS_Server)

When DHCP client is disabled, sets the Preferred DNS Server. Default value is "0.0.0.0". When "DHCP_Enabled=YES", values are ignored.

Example:

Preferred_DNS_Server=192.168.0.1

Alternate DNS Server (Alternate_DNS_Server)

When DHCP client is disabled, sets the Alternate DNS Server. Default value is "0.0.0.0". When "DHCP_Enabled=YES", values are ignored.

Example:

Alternate_DNS_Server=192.168.0.1

Enable Proxy Server (Proxy_Server_Enabled)

Sets whether to enable or disable Proxy Server as follows.

YES Enable Proxy Server
NO (Default) Disable Proxy Server

Example:

Proxy_Server_Enabled=YES

Proxy Server (Proxy_Server_Name)

Sets the domain name or IP Address of Proxy Server. Default is empty. When "Proxy_Server_Enabled=NO", values are ignored.

Example:

Proxy_Server_Name=yourproxy.com
Proxy_Server_Name=123.123.0.1

Proxy Server Port Number (Port_Number)

Sets the Port Number of Proxy Server. Default value is "8080". When "Proxy_Server_Enabled=NO", values are ignored.

Example:

Port_Number=8080

Set connection time-out period (APPAUTOTIME)

Sets the automatic time-out period for Wireless LAN functionality.

When the Wireless LAN mode is 4, the Wireless LAN functionality will stop if other devices are not connecting to the FlashAir for the time specified by this parameter.
The available values are from 60000 to 4294967294, with a default value of 300000. Time is measured in milliseconds.

Specifies 0 to disable the automatic time-out.
Note: The card would stop ex. if the power supply to the card stops.

APPAUTOTIME is valid only when APPMODE is AP. There will be no timeout due to the time set in APPAUTOTIME when APMODE is STA or BRG.

Example:

APPAUTOTIME=3000000

Application's unique information (APPINFO)

Saves information uniquely used by the application using 1 - 16 characters.

Example:

APPINFO=0123ABCD4567EFGH

Wireless LAN mode (APPMODE)

Sets the Wireless LAN mode. The following modes are available:

0 Start the wireless LAN function in manual start mode.
Sets the Wireless LAN to AP mode.
2 Start the wireless LAN function in manual start mode.
Sets the Wireless LAN to STA mode.
3 Start the wireless LAN function in manual start mode.
Sets the Wireless LAN to "Internet pass-thru" mode.
(FW 2.00.02+)
4 Start the wireless LAN function in auto start mode.
Sets the Wireless LAN to AP mode.
5 Start the wireless LAN function in auto start mode.
Sets the Wireless LAN to STA mode.
6 Start the wireless LAN function in auto start mode.
Sets the Wireless LAN to "Internet pass-thru" mode.
(FW 2.00.02+)
Other Undefined behaviour.
Manual start mode
This mode is used to switch the ON / OFF of the wireless LAN function of FlashAir manually.
You can activate the wireless LAN by turning off the image protection of the wireless LAN startup image (/ DCIM / 100__TSB / FA000001.JPG) saved in FlashAir at the time of shipment, and deactivate the wireless LAN by turning on the image protection.
Protection ON / OFF is performed mainly on the digital camera side.
Auto start mode
This mode automatically activates the wireless LAN function when the FlashAir inserted device turns on.
AP mode
In AP mode (i.e. Access Point Mode), the FlashAir behaves like a normal wireless access point - although with no direct internet access
The config file parameters APPSSID and APPNETWORKKEY set the SSID and Network Security Key respectively.
The security mode is WPA2-AES.
STA mode
In STA mode (ie. Station Mode), the FlashAir becomes a Wireless LAN client. This requires another device to act as the access point.
The config file parameters APPSSID and APPNETWORKKEY set the SSID and Network Security Key respectively.
Please refer to Advanced Tutorials - Using Station Mode for further information.
Internet pass-thru mode
In Internet pass-thru mode, the FlashAir becomes both a Wireless Access Point, and a Wireless LAN client.
This allows you to connect to the internet while also connected to your FlashAir.
If the card fails to connect to the second access point, only AP mode functionality will be enabled.
The config file parameters APPSSID and APPNETWORKKEY set the SSID and Network Security Key respectively.
The security mode is WPA2-AES.
The config file parameters BRGSSID and BRGNETWORKKEY set the SSID and Network Security Key to use for the second access point.
Please refer to Advanced Tutorials - Using Internet Pass-Thru Mode for more information.

Example:

APPMODE=4

NETBIOS/Bonjour name (APPNAME)

Sets the name returned from NETBIOS or Bonjour in 15 characters.

If there is no setting in the CONFIG file, or there is no CONFIG file, the name becomes flashair.

Example:

APPNAME=myflashair

Network security key (APPNETWORKKEY)

Sets the network security key using 0 - 63 characters. To enable security functionality, at least 8 characters are required.

Example:

APPNETWORKKEY=12345678

SSID (APPSSID)

Sets the Service Set Identifier (SSID) using 1 - 32 characters.

If this has not yet been set in the CONFIG file or if there is no CONFIG file, the SSID becomes flashair_<MACADDRESS>.

Example:

APPSSID=flashair

Network security key for Internet pass-thru Mode (BRGNETWORKKEY)

Sets the network security key for Internet pass-thru mode using 0 - 63 characters.

Example:

BRGNETWORKKEY=12345678

SSID for Internet pass-thru Mode (BRGSSID)

Sets the Service Set Identifier (SSID) for Internet pass-thru mode using 1 - 32 characters.

Example:

BRGSSID=myhomelan

Card ID (CID)

CID is a Card Identifier specified by the SD standard. The identifier is a 32-digit hexadecimal number.

Example:

CID=02544d53573038470750002a0200c201

Wireless boot screen path (CIPATH)

Sets the full-path of the image to use as the wireless boot screen. The wireless boot screen is an image file that controls whether the Wireless LAN is ON or OFF when the Wireless LAN mode ( APPMODE) is 0, 2, or 3.

Example:

CIPATH=/DCIM/100__TSB/FA000001.jpg

Sets the valid opcode of command.cgi (COMMANDCGI)

Sets the valid opcode of command.cgi.

Example:

COMMANDCGI=100-103

Disable CGI (DELCGI)

Disables specified CGIs.

Parameters:

Specifies one or multiple values in the following list connecting with comma:
/ Disable file downloading operation.
/command.cgi Disable command.cgi
/config.cgi Disable config.cgi
/thumbnail.cgi Disable thumbnail.cgi
/upload.cgi Disable upload.cgi

Example:

DELCGI=/,/thumbnail.cgi

DHCP client retransmission count (DHCPC_RETRANS_MAX)

Sets the number of DHCP client retransmissions. If 0 is specified, retransmit infinitely. The setting value is 0 to 255.

Example:

DHCPC_RETRANS_MAX=5

DNS operation mode (DNSMODE)

Selects the DNS operation mode.

0 Returns the FlashAir's IP Address only if the DNS request is done with the APPNAME or flashair .
1 (Default) resolves and returns the FlashAir's IP Address to DNS requests. For example, even if APPNAME is set to 'myflashair' and accessing with http://flashair resolves to the card's IP address

Example:

DNSMODE=1

File path of TLS certificate (EAPCERT)

Sets the file path of the TLS certificate. Specifiable certificates are in .pfx or .p12 format.

Example:

EAPCERT=/cert.pfx

PEAP password or TLS secret key password (EAPPASSWORD)

Set PEAP password or TLS secret key password.

Example:

EAPPASSWORD=12345678

Encryption standard (EAPTYPE)

When EAPTYPE is set during STA mode setting, it operates in 8021X mode (WPA2 Enterprise). The set value is PEAP , TLS . When PEAP is set, try connection using EAPUSER and EAPPASSWORD parameters. When TLS is specified, connection using client certificate is performed. At this time, specify the SSID of the access point to be connected with APPSSID.

Example:

EAPTYPE=TLS

User ID to use when EAPTYPE is specified (EAPUSER)

Sets the user ID to use when EAPTYPE is specified.

Example:

EAPUSER=SMITH

Memory size (HTTPDBUFF)

By reducing the amount of memory used in the HTTP server, you can increase the amount of memory used in Lua script execution. Note that in the case of reducing the memory of the HTTP server, the download throughput will decrease. The range of value is from 2920 to 23360. Default value is 23360.

Example:

HTTPDBUFF=2920

Authentication method (HTTPDMODE)

Specifies authentication method used by built-in HTTP server. Specify one of the following values.

0 (default) No authentication
1 Basic access authentication
2 Digest access authentication

Example:

HTTPDMODE=1

Authentication password (HTTPDPASS)

Specifies a password for Basic access authentication or a hash key for Digest access authentication.
Digest authentication Realm is "Secret Zone".For Digest authentication, please write the following value in 32-digit hexadecimal number.
MD5(Username ":" "Secret Zone" ":" Password).

Example(Basic access authentication):

HTTPDPASS=12345678

Example(Digest access authentication):

Username: username
Password: password
In this case, calculate MD5("username:Secret Zone:password").
HTTPDPASS=66643ffbf66badfe10b904134e6bd1dc

Authentication user name (HTTPDUSER)

Specifies a user name for Basic access authentication. This parameter is not used for Digest access authentication.

Example:

HTTPDUSER=flashair

SD Interface Enable Flag (IFMODE)

Enables the usage of the SD Interface User I/O.

Please refer to command.cgi: Control SD Interface as user I/O for more information.

1 Enabled
Other (Default) Disabled

Example:

IFMODE=1

Default configured flag (LOCK)

This flag indicates whether the default configuration has been completed. If the default configuration is set, the flag will be set to 1. If the default configured flag does not exist, the SSID and network security setting screen will be displayed when the FlashAir is connected to a web browser. Please do not set this flag to any value other than 1.

Example:

LOCK=1

Path to a Lua script to execute on boot (LUA_RUN_SCRIPT)

Sets the absolute path to a Lua script that will be executed on boot. The script will run 5 minutes after the FlashAir boots.

Example:

LUA_RUN_SCRIPT=/bootscript.lua

Path to a Lua script to execute on a write event (LUA_SD_EVENT)

Sets the absolute path to a Lua script that will be executed on a write event. The script will run every time a file is written to the FlashAir. It is executed 0.5 seconds after writing the last data.

Example:

LUA_SD_EVENT=/writescript.lua

Master code (MASTERCODE)

The master code is a 12-digit hexadecimal number which is used as a password to set the SSID (APPSSID) and network security key (APPNETWORKKEY). If the master code is not yet set, please set it via config.cgi before changing any settings.

Example:

MASTERCODE=0123456789AB

Noise Cancel (NOISE_CANCEL)

Improves connection at the cost of decreased range of the signal, which can be beneficiary in a noisy environment.

2 Enable Noise Cancelling
Other (Default) Disable Noise Cancelling

Example:

NOISE_CANCEL=2

Product code (PRODUCT)

The product name of the FlashAir.

Example:

PRODUCT=FlashAir

HTTP redirect mode (REDIRECT)

Changes the HTTP redirect mode. The following modes are available:

1 (Default) Enable redirecting
0 Disable redirecting

Example:

REDIRECT=1

Address filtering function in STA mode (STAMAC)

Sets the address filtering function in STA mode. Up to seven can be registered when registering more than one. In that case, you need to list multiple lines of STAMAC.

Example:

STAMAC=40b395A0851a

Limited number of connections in STA mode (STANUM)

Sets the connection limit in STA mode. Up to seven units can be connected if not described.

Example:

STANUM=2

Number of connection retried in STA mode (STA_RETRY_CT)

Sets how many times to retry connecting to a wireless LAN in STA mode. 0will retry indefinitely.

Example:

STA_RETRY_CT=3

Timezone (TIMEZONE)

Sets the timezone that will be used to convert from FAT file time to UTC time when FlashAir Drive is run. The timezone is stored in 15 minute increments, ranging from -48 to 54. For example UTC standard time is 0, and Japan time (which is 9 hours ahead), is 36 (9(h)×4(15m)=36).

Example:

TIMEZONE=36

Upload destination directory (UPDIR)

Specifies the directory to upload.

Example:

UPDIR=/DCIM

Upload operation enabled flag (UPLOAD)

Sets whether the upload operation is enabled or not using one of following values:

1 Upload operation enabled
Other (Default) Upload operation disabled

Example:

UPLOAD=1

Vendor code (VENDOR)

The vendor name of the FlashAir.

Example:

VENDOR=TOSHIBA

Firmware version (VERSION)

The firmware version for the FlashAir

Example:

VERSION=F24A6W3AW1.00.03

FlashAir Drive(WebDAV) (WEBDAV)

Sets whether to enable or disable FlashAir Drive. The following modes are available:

0 Disable FlashAir Drive
1 Enable FlashAir Drive(read only)
2 Enable FlashAir Drive. Needs also UPLOAD=1 to write files.

Example:

WEBDAV=0

Wireless LAN Standard (WLANAPMODE)

Sets the Wireless LAN Standard as follows.

0x01 802.11b
0x02 802.11g
0x03 (Default) 802.11bg
0x82 802.11ng

Example:

WLANAPMODE=0x03