Mistake on this page?
Report an issue in GitHub or email us
Public Types | Public Member Functions | Static Public Member Functions
WisunInterface Class Referencefinal

Wi-SUN mesh network interface class. More...

#include <WisunInterface.h>

Inheritance diagram for WisunInterface:
MeshInterfaceNanostack InterfaceNanostack MeshInterface NonCopyable< MeshInterfaceNanostack > NetworkInterface NetworkInterface DNS DNS

Public Types

typedef mbed::Callback< void(nsapi_value_or_error_t result, SocketAddress *address)> hostbyname_cb_t
 Hostname translation callback (for use with gethostbyname_async()). More...
 

Public Member Functions

mesh_error_t set_network_name (char *network_name)
 Set Wi-SUN network name. More...
 
mesh_error_t get_network_name (char *network_name)
 Get Wi-SUN network name. More...
 
mesh_error_t validate_network_name (char *network_name)
 Validate Wi-SUN network name. More...
 
mesh_error_t set_network_regulatory_domain (uint8_t regulatory_domain=0xff, uint8_t operating_class=0xff, uint8_t operating_mode=0xff)
 Set Wi-SUN network regulatory domain, operating class and operating mode. More...
 
mesh_error_t get_network_regulatory_domain (uint8_t *regulatory_domain, uint8_t *operating_class, uint8_t *operating_mode)
 Get Wi-SUN network regulatory domain, operating class and operating mode. More...
 
mesh_error_t validate_network_regulatory_domain (uint8_t regulatory_domain, uint8_t operating_class, uint8_t operating_mode)
 Validate Wi-SUN network regulatory domain, operating class and operating mode. More...
 
mesh_error_t set_network_size (uint8_t network_size)
 Set Wi-SUN network size. More...
 
mesh_error_t get_network_size (uint8_t *network_size)
 Get Wi-SUN network size. More...
 
mesh_error_t validate_network_size (uint8_t network_size)
 Validate Wi-SUN network size. More...
 
mesh_error_t set_channel_mask (uint32_t channel_mask[8])
 Set Wi-SUN FHSS channel mask. More...
 
mesh_error_t get_channel_mask (uint32_t *channel_mask)
 Get Wi-SUN FHSS channel mask. More...
 
mesh_error_t validate_channel_mask (uint32_t channel_mask[8])
 Validate Wi-SUN FHSS channel mask. More...
 
mesh_error_t set_unicast_channel_function (mesh_channel_function_t channel_function, uint16_t fixed_channel=0xffff, uint8_t dwell_interval=0x00)
 Set Wi-SUN FHSS unicast channel function parameters. More...
 
mesh_error_t get_unicast_channel_function (mesh_channel_function_t *channel_function, uint16_t *fixed_channel, uint8_t *dwell_interval)
 Get Wi-SUN FHSS unicast channel function parameters. More...
 
mesh_error_t validate_unicast_channel_function (mesh_channel_function_t channel_function, uint16_t fixed_channel, uint8_t dwell_interval)
 Validate Wi-SUN FHSS unicast channel function parameters. More...
 
mesh_error_t set_broadcast_channel_function (mesh_channel_function_t channel_function, uint16_t fixed_channel=0xffff, uint8_t dwell_interval=0x00, uint32_t broadcast_interval=0x00)
 Set Wi-SUN FHSS broadcast channel function parameters. More...
 
mesh_error_t get_broadcast_channel_function (mesh_channel_function_t *channel_function, uint16_t *fixed_channel, uint8_t *dwell_interval, uint32_t *broadcast_interval)
 Get Wi-SUN FHSS broadcast channel function parameters. More...
 
mesh_error_t validate_broadcast_channel_function (mesh_channel_function_t channel_function, uint16_t fixed_channel, uint8_t dwell_interval, uint32_t broadcast_interval)
 Validate Wi-SUN FHSS broadcast channel function parameters. More...
 
mesh_error_t set_timing_parameters (uint16_t disc_trickle_imin=0x00, uint16_t disc_trickle_imax=0x00, uint8_t disc_trickle_k=0x00, uint16_t pan_timeout=0x00)
 Set Wi-SUN timing parameters. More...
 
mesh_error_t get_timing_parameters (uint16_t *disc_trickle_imin, uint16_t *disc_trickle_imax, uint8_t *disc_trickle_k, uint16_t *pan_timeout)
 Get Wi-SUN timing parameters. More...
 
mesh_error_t validate_timing_parameters (uint16_t disc_trickle_imin, uint16_t disc_trickle_imax, uint8_t disc_trickle_k, uint16_t pan_timeout)
 Validates Wi-SUN timing parameters. More...
 
mesh_error_t set_device_min_sens (uint8_t device_min_sens)
 Set Wi-SUN device minimum sensitivity. More...
 
mesh_error_t get_device_min_sens (uint8_t *device_min_sens)
 Get Wi-SUN device minimum sensitivity. More...
 
mesh_error_t validate_device_min_sens (uint8_t device_min_sens)
 Validates Device minimum sensitivity. More...
 
mesh_error_t set_own_certificate (uint8_t *cert, uint16_t cert_len, uint8_t *cert_key=NULL, uint16_t cert_key_len=0)
 Set own certificate and private key reference to the Wi-SUN network. More...
 
mesh_error_t remove_own_certificates (void)
 Remove own certificates from the Wi-SUN network. More...
 
mesh_error_t set_trusted_certificate (uint8_t *cert, uint16_t cert_len)
 Set trusted certificate reference to the Wi-SUN network. More...
 
mesh_error_t remove_trusted_certificates (void)
 Remove trusted certificates from the Wi-SUN network. More...
 
bool getRouterIpAddress (char *address, int8_t len)
 Get router IP address. More...
 
mesh_error_t enable_statistics (void)
 Enable Wi-SUN statistics. More...
 
mesh_error_t read_nw_statistics (mesh_nw_statistics_t *statistics)
 Reads Wi-SUN network statistics. More...
 
mesh_error_t read_mac_statistics (mesh_mac_statistics_t *statistics)
 Reads Wi-SUN MAC statistics. More...
 
mesh_error_t info_get (ws_rpl_info_t *info_ptr)
 Get Wi-SUN Router information. More...
 
mesh_error_t stack_info_get (ws_stack_state_t *stack_info_ptr)
 Get Wi-SUN Stack information. More...
 
mesh_error_t cca_threshold_table_get (ws_cca_threshold_table_t *table)
 Get Wi-SUN CCA threshold table information. More...
 
nsapi_error_t initialize (NanostackRfPhy *phy)
 Attach phy and initialize the mesh. More...
 
nsapi_error_t connect () override
 Start the interface. More...
 
nsapi_error_t disconnect () override
 Stop the interface. More...
 
nsapi_error_t get_ip_address (SocketAddress *address) override
 Get the local IP address. More...
 
const char * get_mac_address () override
 Get the internally stored MAC address /return MAC address of the interface. More...
 
nsapi_error_t set_mac_address (uint8_t *mac_addr, nsapi_size_t addr_len) override
 Set the MAC address to the interface. More...
 
void attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb) override
 Register callback for status reporting. More...
 
nsapi_connection_status_t get_connection_status () const override
 Get the connection status. More...
 
nsapi_error_t set_blocking (bool blocking) override
 Set blocking status of connect() which by default should be blocking. More...
 
nsapi_error_t set_file_system_root_path (const char *root_path)
 Set file system root path. More...
 
int8_t get_interface_id () const
 Get the interface ID. More...
 
virtual void set_as_default ()
 Set network interface as default one. More...
 
virtual nsapi_error_t get_ipv6_link_local_address (SocketAddress *address)
 Get the IPv6 link local address. More...
 
virtual nsapi_error_t get_netmask (SocketAddress *address)
 Get the local network mask. More...
 
virtual nsapi_error_t get_gateway (SocketAddress *address)
 Get the local gateway. More...
 
virtual char * get_interface_name (char *interface_name)
 Get the network interface name. More...
 
virtual nsapi_error_t set_network (const SocketAddress &ip_address, const SocketAddress &netmask, const SocketAddress &gateway)
 Configure this network interface to use a static IP address. More...
 
virtual nsapi_error_t set_dhcp (bool dhcp)
 Enable or disable DHCP on connecting the network. More...
 
virtual nsapi_error_t gethostbyname (const char *host, SocketAddress *address, nsapi_version_t version=NSAPI_UNSPEC, const char *interface_name=NULL)
 Translate a hostname to an IP address with specific version using network interface name. More...
 
virtual nsapi_value_or_error_t getaddrinfo (const char *hostname, SocketAddress *hints, SocketAddress **res, const char *interface_name=NULL)
 Translate a hostname to the multiple IP addresses with specific version using network interface name. More...
 
virtual nsapi_value_or_error_t gethostbyname_async (const char *host, hostbyname_cb_t callback, nsapi_version_t version=NSAPI_UNSPEC, const char *interface_name=NULL)
 Translate a hostname to an IP address (asynchronous) using network interface name. More...
 
virtual nsapi_value_or_error_t getaddrinfo_async (const char *hostname, SocketAddress *hints, hostbyname_cb_t callback, const char *interface_name=NULL)
 Translate a hostname to the multiple IP addresses (asynchronous) using network interface name. More...
 
virtual nsapi_error_t gethostbyname_async_cancel (int id)
 Cancel asynchronous hostname translation. More...
 
virtual nsapi_error_t add_dns_server (const SocketAddress &address, const char *interface_name)
 Add a domain name server to list of servers to query. More...
 
virtual nsapi_error_t get_dns_server (int index, SocketAddress *address, const char *interface_name=NULL)
 Get a domain name server from a list of servers to query. More...
 
void add_event_listener (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
 Add event listener for interface. More...
 
virtual EthInterfaceethInterface ()
 Return pointer to an EthInterface. More...
 
virtual WiFiInterfacewifiInterface ()
 Return pointer to a WiFiInterface. More...
 
virtual MeshInterfacemeshInterface ()
 Return pointer to a MeshInterface. More...
 
MeshInterfacemeshInterface () final
 Return pointer to a MeshInterface. More...
 
virtual EMACInterfaceemacInterface ()
 Return pointer to an EMACInterface. More...
 
virtual CellularInterfacecellularInterface ()
 Return pointer to a CellularInterface. More...
 
virtual void set_default_parameters ()
 defined(DOXYGEN_ONLY) More...
 

Static Public Member Functions

static NetworkInterfaceget_default_instance ()
 Return the default network interface. More...
 
static MeshInterfaceget_default_instance ()
 Get the default Mesh interface. More...
 

Detailed Description

Wi-SUN mesh network interface class.

Configure Nanostack to use Wi-SUN protocol.

Definition at line 74 of file WisunInterface.h.

Member Typedef Documentation

typedef mbed::Callback<void (nsapi_value_or_error_t result, SocketAddress *address)> hostbyname_cb_t
inherited

Hostname translation callback (for use with gethostbyname_async()).

Callback will be called after DNS resolution completes or a failure occurs.

Note
Callback should not take more than 10ms to execute, otherwise it might prevent underlying thread processing. A portable user of the callback should not make calls to network operations due to stack size limitations. The callback should not perform expensive operations such as socket recv/send calls or blocking operations.
Parameters
resultNegative error code on failure or value that represents the number of DNS records
addressOn success, destination for the host SocketAddress.

Definition at line 284 of file NetworkInterface.h.

Member Function Documentation

virtual nsapi_error_t add_dns_server ( const SocketAddress address,
const char *  interface_name 
)
virtualinherited

Add a domain name server to list of servers to query.

Parameters
addressAddress for the dns host.
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

void add_event_listener ( mbed::Callback< void(nsapi_event_t, intptr_t)>  status_cb)
inherited

Add event listener for interface.

This API allows multiple callback to be registered for a single interface. When first called, internal list of event handlers are created and registered to interface through attach() API.

Application may only use attach() or add_event_listener() interface. Mixing usage of both leads to undefined behavior.

Parameters
status_cbThe callback for status changes.
void attach ( mbed::Callback< void(nsapi_event_t, intptr_t)>  status_cb)
overridevirtualinherited

Register callback for status reporting.

The specified status callback function will be called on status changes on the network. The parameters on the callback are the event type and event-type dependent reason parameter.

Parameters
status_cbThe callback for status changes

Reimplemented from NetworkInterface.

mesh_error_t cca_threshold_table_get ( ws_cca_threshold_table_t table)

Get Wi-SUN CCA threshold table information.

Function reads CCA threshold table from nanostack.

Parameters
ws_cca_threshold_table_tStructure given to stack where information will be stored
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
virtual CellularInterface* cellularInterface ( )
virtualinherited

Return pointer to a CellularInterface.

Returns
Pointer to requested interface type or NULL if this class doesn't implement the interface.

Reimplemented in CellularInterface.

Definition at line 456 of file NetworkInterface.h.

nsapi_error_t connect ( )
overridevirtualinherited

Start the interface.

Returns
0 on success, negative error code on failure

Implements NetworkInterface.

nsapi_error_t disconnect ( )
overridevirtualinherited

Stop the interface.

Returns
0 on success, negative error code on failure

Implements NetworkInterface.

virtual EMACInterface* emacInterface ( )
virtualinherited

Return pointer to an EMACInterface.

Returns
Pointer to requested interface type or NULL if this class doesn't implement the interface.

Reimplemented in EMACInterface.

Definition at line 448 of file NetworkInterface.h.

mesh_error_t enable_statistics ( void  )

Enable Wi-SUN statistics.

After enabling statistics those can be read using the network, physical layer, MAC and FHSS and Wi-SUN statistics read functions.

Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN on error
virtual EthInterface* ethInterface ( )
virtualinherited

Return pointer to an EthInterface.

Returns
Pointer to requested interface type or NULL if this class doesn't implement the interface.

Reimplemented in EthInterface.

Definition at line 424 of file NetworkInterface.h.

mesh_error_t get_broadcast_channel_function ( mesh_channel_function_t *  channel_function,
uint16_t *  fixed_channel,
uint8_t *  dwell_interval,
uint32_t *  broadcast_interval 
)

Get Wi-SUN FHSS broadcast channel function parameters.

Function reads FHSS broadcast channel function parameters from mbed-mesh-api.

Parameters
channel_functionChannel function. Fixed, TR51CF, DH1CF or vendor defined.
fixed_channelUsed channel when channel function is fixed channel.
dwell_intervalUsed dwell interval when channel function is TR51 or DH1.
broadcast_intervalUsed broadcast interval.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t get_channel_mask ( uint32_t *  channel_mask)

Get Wi-SUN FHSS channel mask.

Function reads FHSS channel mask from mbed-mesh-api.

Parameters
channel_maskValues defined in Wi-SUN management API. Channel mask bit field.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
nsapi_connection_status_t get_connection_status ( ) const
overridevirtualinherited

Get the connection status.

Returns
The connection status according to ConnectionStatusType

Reimplemented from NetworkInterface.

static MeshInterface* get_default_instance ( )
staticinherited

Get the default Mesh interface.

This is provided as a weak method so applications can override. Default behavior is to get the target's default interface, if any.

Returns
pointer to interface, if any.
static NetworkInterface* get_default_instance ( )
staticinherited

Return the default network interface.

Returns the default network interface, as determined by JSON option target.network-default-interface-type or other overrides.

The type of the interface returned can be tested by calling ethInterface(), wifiInterface(), meshInterface(), cellularInterface(), emacInterface() and checking for NULL pointers.

The default behavior is to return the default interface for the interface type specified by target.network-default-interface-type. Targets should set this in their targets.json to guide default selection, and applications may override.

The interface returned should be already configured for use such that its connect() method works with no parameters. For connection types needing configuration, settings should normally be obtained from JSON - the settings for the core types are under the "nsapi" JSON config tree.

The list of possible settings for default interface type is open-ended, as is the number of possible providers. Core providers are:

Specific drivers may be activated by other settings of the default-network-interface-type configuration. This will depend on the target and the driver. For example a board may have its default setting as "AUTO" which causes it to autodetect an Ethernet cable. This should be described in the target's documentation.

An application can override all target settings by implementing NetworkInterface::get_default_instance() themselves - the default definition is weak, and calls get_target_default_instance().

mesh_error_t get_device_min_sens ( uint8_t *  device_min_sens)

Get Wi-SUN device minimum sensitivity.

Function reads device minimum sensitivity from mbed-mesh-api.

Parameters
device_min_sensDevice minimum sensitivity. Range 0-254.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
virtual nsapi_error_t get_dns_server ( int  index,
SocketAddress address,
const char *  interface_name = NULL 
)
virtualinherited

Get a domain name server from a list of servers to query.

Returns a DNS server address for a index. If returns error no more DNS servers to read.

Parameters
indexIndex of the DNS server, starts from zero
addressDestination for the host address
interface_nameNetwork interface name
Returns
NSAPI_ERROR_OK on success, negative error code on failure
virtual nsapi_error_t get_gateway ( SocketAddress address)
virtualinherited

Get the local gateway.

Parameters
addressSocketAddress representation of gateway address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

Reimplemented in EMACInterface, L3IPInterface, PPPInterface, and UBLOX_AT_CellularContext.

int8_t get_interface_id ( ) const
inherited

Get the interface ID.

Returns
Interface identifier

Definition at line 145 of file MeshInterfaceNanostack.h.

virtual char* get_interface_name ( char *  interface_name)
virtualinherited

Get the network interface name.

Returns
Null-terminated representation of the network interface name or null if interface not exists

Reimplemented in EMACInterface, L3IPInterface, PPPInterface, and AT_CellularContext.

nsapi_error_t get_ip_address ( SocketAddress address)
overridevirtualinherited

Get the local IP address.

Parameters
addressSocketAddress representation of the local IP address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

Reimplemented from NetworkInterface.

virtual nsapi_error_t get_ipv6_link_local_address ( SocketAddress address)
virtualinherited

Get the IPv6 link local address.

Parameters
addressSocketAddress representation of the link local IPv6 address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid

Reimplemented in EMACInterface.

const char* get_mac_address ( )
overridevirtualinherited

Get the internally stored MAC address /return MAC address of the interface.

Reimplemented from NetworkInterface.

virtual nsapi_error_t get_netmask ( SocketAddress address)
virtualinherited

Get the local network mask.

Parameters
addressSocketAddress representation of netmask
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

mesh_error_t get_network_name ( char *  network_name)

Get Wi-SUN network name.

Function reads network name from mbed-mesh-api.

Parameters
network_nameNetwork name as NUL terminated string. Must have space for 33 characters (string and null terminator).
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t get_network_regulatory_domain ( uint8_t *  regulatory_domain,
uint8_t *  operating_class,
uint8_t *  operating_mode 
)

Get Wi-SUN network regulatory domain, operating class and operating mode.

Function reads regulatory_domain, operating_class and operating_mode from mbed-mesh-api.

Parameters
regulatory_domainValues defined in Wi-SUN PHY-specification.
operating_classValues defined in Wi-SUN PHY-specification.
operating_modeValues defined in Wi-SUN PHY-specification.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t get_network_size ( uint8_t *  network_size)

Get Wi-SUN network size.

Function reads network size from mbed-mesh-api.

Parameters
network_sizeNetwork size in hundreds of devices, 0x00 for network size certificate.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t get_timing_parameters ( uint16_t *  disc_trickle_imin,
uint16_t *  disc_trickle_imax,
uint8_t *  disc_trickle_k,
uint16_t *  pan_timeout 
)

Get Wi-SUN timing parameters.

Function reads timing parameters from mbed-mesh-api.

Parameters
disc_trickle_iminDiscovery trickle Imin. Range 1-255 seconds.
disc_trickle_imaxDiscovery trickle Imax. Range (2-2^8)*Imin.
disc_trickle_kDiscovery trickle k.
pan_timeoutPAN timeout; seconds; Range 60-15300 seconds.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t get_unicast_channel_function ( mesh_channel_function_t *  channel_function,
uint16_t *  fixed_channel,
uint8_t *  dwell_interval 
)

Get Wi-SUN FHSS unicast channel function parameters.

Function reads FHSS unicast channel function parameters from mbed-mesh-api.

Parameters
channel_functionChannel function. Fixed, TR51CF, DH1CF or vendor defined.
fixed_channelUsed channel when channel function is fixed channel.
dwell_intervalUsed dwell interval when channel function is TR51 or DH1.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
virtual nsapi_value_or_error_t getaddrinfo ( const char *  hostname,
SocketAddress hints,
SocketAddress **  res,
const char *  interface_name = NULL 
)
virtualinherited

Translate a hostname to the multiple IP addresses with specific version using network interface name.

The hostname may be either a domain name or an IP address. If the hostname is an IP address, no network transactions will be performed.

If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.

Parameters
hostnameHostname to resolve.
hintsPointer to a SocketAddress with query parameters.
resPointer to a SocketAddress array to store the result..
interface_nameNetwork interface name
Returns
number of results on success, negative error code on failure.

Implements DNS.

virtual nsapi_value_or_error_t getaddrinfo_async ( const char *  hostname,
SocketAddress hints,
hostbyname_cb_t  callback,
const char *  interface_name = NULL 
)
virtualinherited

Translate a hostname to the multiple IP addresses (asynchronous) using network interface name.

The hostname may be either a domain name or a dotted IP address. If the hostname is an IP address, no network transactions will be performed.

If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.

Call is non-blocking. Result of the DNS operation is returned by the callback. If this function returns failure, callback will not be called. In case result is success (IP address was found from DNS cache), callback will be called before function returns.

Parameters
hostnameHostname to resolve.
hintsPointer to a SocketAddress with query parameters.
callbackCallback that is called for result.
interface_nameNetwork interface name
Returns
0 on immediate success, negative error code on immediate failure or a positive unique id that represents the hostname translation operation and can be passed to cancel.

Implements DNS.

virtual nsapi_error_t gethostbyname ( const char *  host,
SocketAddress address,
nsapi_version_t  version = NSAPI_UNSPEC,
const char *  interface_name = NULL 
)
virtualinherited

Translate a hostname to an IP address with specific version using network interface name.

The hostname may be either a domain name or an IP address. If the hostname is an IP address, no network transactions will be performed.

If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.

Parameters
hostHostname to resolve.
addressPointer to a SocketAddress to store the result.
versionIP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC).
interface_nameNetwork interface name
Return values
NSAPI_ERROR_OKon success
intNegative error code on failure. See NetworkStack::gethostbyname

Implements DNS.

virtual nsapi_value_or_error_t gethostbyname_async ( const char *  host,
hostbyname_cb_t  callback,
nsapi_version_t  version = NSAPI_UNSPEC,
const char *  interface_name = NULL 
)
virtualinherited

Translate a hostname to an IP address (asynchronous) using network interface name.

The hostname may be either a domain name or a dotted IP address. If the hostname is an IP address, no network transactions will be performed.

If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.

Call is non-blocking. Result of the DNS operation is returned by the callback. If this function returns failure, callback will not be called. In case result is success (IP address was found from DNS cache), callback will be called before function returns.

Parameters
hostHostname to resolve.
callbackCallback that is called for result.
versionIP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC).
interface_nameNetwork interface name
Returns
0 on immediate success, negative error code on immediate failure or a positive unique id that represents the hostname translation operation and can be passed to cancel.

Implements DNS.

virtual nsapi_error_t gethostbyname_async_cancel ( int  id)
virtualinherited

Cancel asynchronous hostname translation.

When translation is cancelled, callback will not be called.

Parameters
idUnique id of the hostname translation operation (returned by gethostbyname_async)
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

bool getRouterIpAddress ( char *  address,
int8_t  len 
)

Get router IP address.

Parameters
address
len
mesh_error_t info_get ( ws_rpl_info_t info_ptr)

Get Wi-SUN Router information.

Function reads RPL information from nanostack. Mesh interface must be initialized before calling this function.

Parameters
info_ptrStructure given to stack where information will be stored
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
nsapi_error_t initialize ( NanostackRfPhy phy)
inherited

Attach phy and initialize the mesh.

Initializes a mesh interface on the given phy. Not needed if the phy is passed to the mesh's constructor.

Returns
0 on success, negative on failure
MeshInterface* meshInterface ( )
finalvirtualinherited

Return pointer to a MeshInterface.

Returns
Pointer to requested interface type or NULL if this class doesn't implement the interface.

Reimplemented from NetworkInterface.

Definition at line 34 of file MeshInterface.h.

virtual MeshInterface* meshInterface ( )
virtualinherited

Return pointer to a MeshInterface.

Returns
Pointer to requested interface type or NULL if this class doesn't implement the interface.

Reimplemented in MeshInterface.

Definition at line 440 of file NetworkInterface.h.

mesh_error_t read_mac_statistics ( mesh_mac_statistics_t statistics)

Reads Wi-SUN MAC statistics.

Reads MAC statistics.

Parameters
statisticsMAC statistics.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN on error
mesh_error_t read_nw_statistics ( mesh_nw_statistics_t statistics)

Reads Wi-SUN network statistics.

Reads network statistics.

Parameters
statisticsNetwork statistics.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN on error
mesh_error_t remove_own_certificates ( void  )

Remove own certificates from the Wi-SUN network.

Function must be called before connecting the device i.e before call to connect() method.

Returns
MESH_ERROR_NONE on success.
MESH_ERROR_STATE if method is called after calling connect().
mesh_error_t remove_trusted_certificates ( void  )

Remove trusted certificates from the Wi-SUN network.

Function must be called before connecting the device i.e before call to connect() method.

Returns
MESH_ERROR_NONE on success.
MESH_ERROR_STATE if method is called after calling connect().
virtual void set_as_default ( )
virtualinherited

Set network interface as default one.

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

nsapi_error_t set_blocking ( bool  blocking)
overridevirtualinherited

Set blocking status of connect() which by default should be blocking.

Parameters
blockingtrue if connect is blocking
Returns
0 on success, negative error code on failure

Reimplemented from NetworkInterface.

mesh_error_t set_broadcast_channel_function ( mesh_channel_function_t  channel_function,
uint16_t  fixed_channel = 0xffff,
uint8_t  dwell_interval = 0x00,
uint32_t  broadcast_interval = 0x00 
)

Set Wi-SUN FHSS broadcast channel function parameters.

Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then device will restart network discovery after changing the channel function, fixed channel, dwell interval or broadcast_interval.

Function overwrites parameters defined by Mbed OS configuration.

Parameters
channel_functionChannel function. Fixed, TR51CF, DH1CF or vendor defined.
fixed_channelUsed channel when channel function is fixed channel. Use 0xffff when fixed channel function not on use.
dwell_intervalUsed dwell interval when channel function is TR51 or DH1. Use 0x00 to use leave parameter unchanged.
broadcast_intervalUsed broadcast interval. Use 0x00 to use leave parameter unchanged.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t set_channel_mask ( uint32_t  channel_mask[8])

Set Wi-SUN FHSS channel mask.

Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then settings take effect right away.

Parameters
channel_maskValues defined in Wi-SUN management API. Channel mask bit field.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
virtual void set_default_parameters ( )
virtualinherited

defined(DOXYGEN_ONLY)

Set default parameters on an interface.

A network interface instantiated directly or using calls such as WiFiInterface::get_default_instance() is initially unconfigured. This call can be used to set the default parameters that would have been set if the interface had been requested using NetworkInterface::get_default_instance() (see nsapi JSON configuration).

Reimplemented in WiFiInterface, and CellularInterface.

mesh_error_t set_device_min_sens ( uint8_t  device_min_sens)

Set Wi-SUN device minimum sensitivity.

Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then settings take effect right away.

Parameters
device_min_sensDevice minimum sensitivity. Range 0(-174 dB) to 254(+80 dB).
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
virtual nsapi_error_t set_dhcp ( bool  dhcp)
virtualinherited

Enable or disable DHCP on connecting the network.

Enabled by default unless a static IP address has been assigned. Requires that the network is disconnected.

Parameters
dhcpTrue to enable DHCP.
Return values
NSAPI_ERROR_OKon success.
NSAPI_ERROR_UNSUPPORTEDif operation is not supported.

Reimplemented in EMACInterface, and L3IPInterface.

nsapi_error_t set_file_system_root_path ( const char *  root_path)
inherited

Set file system root path.

Set file system root path that stack will use to write and read its data. Setting root_path to NULL will disable file system usage.

Parameters
root_pathAddress to NUL-terminated root-path string or NULL to disable file system usage.
Returns
MESH_ERROR_NONE on success, MESH_ERROR_MEMORY in case of memory failure, MESH_ERROR_UNKNOWN in case of other error.
nsapi_error_t set_mac_address ( uint8_t *  mac_addr,
nsapi_size_t  addr_len 
)
overridevirtualinherited

Set the MAC address to the interface.

Set the provided MAC address on the network interface. The address must be unique globally. The address must be set before calling the interface connect() method.

Not all interfaces are supporting MAC address set and an error is not returned for this method call. Verify the changed MAC address by checking packet captures from the used network interface.

6-byte EUI-48 MAC addresses are used for Ethernet while Mesh interface is using 8-byte EUI-64 address.

More information about obtaining MAC address can be found from: https://standards.ieee.org/products-services/regauth/index.html

Parameters
mac_addrBuffer containing the MAC address in hexadecimal format.
addr_lenLength of provided buffer in bytes (6 or 8)
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif address is not valid
NSAPI_ERROR_BUSYif address can't be set.

Reimplemented from NetworkInterface.

virtual nsapi_error_t set_network ( const SocketAddress ip_address,
const SocketAddress netmask,
const SocketAddress gateway 
)
virtualinherited

Configure this network interface to use a static IP address.

Implicitly disables DHCP, which can be enabled in set_dhcp. Requires that the network is disconnected.

Parameters
ip_addressSocketAddress object containing the local IP address
netmaskSocketAddress object containing the local network mask
gatewaySocketAddress object containing the local gateway
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this function is unsupported

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

mesh_error_t set_network_name ( char *  network_name)

Set Wi-SUN network name.

Function stores new network name to mbed-mesh-api and uses it when connect() is called next time. If device is already connected to the Wi-SUN network then device will restart network discovery after changing the network name.

Function overwrites network name defined by Mbed OS configuration.

Parameters
network_nameNetwork name as NUL terminated string. Can't exceed 32 characters and can't be NULL.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t set_network_regulatory_domain ( uint8_t  regulatory_domain = 0xff,
uint8_t  operating_class = 0xff,
uint8_t  operating_mode = 0xff 
)

Set Wi-SUN network regulatory domain, operating class and operating mode.

Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then device will restart network discovery after changing the regulatory_domain, operating_class or operating_mode.

Function overwrites parameters defined by Mbed OS configuration.

Parameters
regulatory_domainValues defined in Wi-SUN PHY-specification. Use 0xff to use leave parameter unchanged.
operating_classValues defined in Wi-SUN PHY-specification. Use 0xff to use leave parameter unchanged.
operating_modeValues defined in Wi-SUN PHY-specification. Use 0xff to use leave parameter unchanged.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t set_network_size ( uint8_t  network_size)

Set Wi-SUN network size.

Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then device will restart network discovery after changing the network size.

Default value: medium Small network size: less than hundred devices Medium network size: hundreds of devices Large network size: thousands of devices Certificate: used on testing

When network size is changed, it will override all or some of the following configuration values:

  • Timing settings set by set_timing_parameters() of the Wi-SUN interface.
  • RPL settings set by rpl_parameters_set() of the Border Router interface.

When network size is changed, and if timing or RPL values should be other than defaults set by stack for the network size, they need to set again using above function calls.

Parameters
network_sizeNetwork size in hundreds of devices (e.g. 1200 devices is 12), 0x00 for network size certificate.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t set_own_certificate ( uint8_t *  cert,
uint16_t  cert_len,
uint8_t *  cert_key = NULL,
uint16_t  cert_key_len = 0 
)

Set own certificate and private key reference to the Wi-SUN network.

Function can be called several times if intermediate certificates are used. Then each call to the function adds a certificate reference to own certificate chain. Certificates are in bottom up order i.e. the top certificate is given last.

Function must be called before connecting the device i.e before call to connect() method. Function will not copy certificate or key, therefore addresses must remain valid.

Parameters
certCertificate address.
cert_lenCertificate length in bytes.
cert_keyCertificate key address.
cert_key_lenCertificate key length in bytes.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_STATE if method is called after calling connect().
MESH_ERROR_MEMORY in case of memory allocation failure.
mesh_error_t set_timing_parameters ( uint16_t  disc_trickle_imin = 0x00,
uint16_t  disc_trickle_imax = 0x00,
uint8_t  disc_trickle_k = 0x00,
uint16_t  pan_timeout = 0x00 
)

Set Wi-SUN timing parameters.

Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then settings take effect right away.

Parameters
disc_trickle_iminDiscovery trickle Imin. Range 1-255 seconds. Use 0x00 to use leave parameter unchanged.
disc_trickle_imaxDiscovery trickle Imax. Range (2-2^8)*Imin. Use 0x00 to use leave parameter unchanged.
disc_trickle_kDiscovery trickle k. Use 0x00 to use leave parameter unchanged.
pan_timeoutPAN timeout; seconds; Range 60-15300 seconds. Use 0x00 to use leave parameter unchanged.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t set_trusted_certificate ( uint8_t *  cert,
uint16_t  cert_len 
)

Set trusted certificate reference to the Wi-SUN network.

Function can be called several times. Certificates are in bottom up order i.e. the top certificate is given last.

Function must be called before connecting the device i.e before call to connect() method. Function will not copy certificate, therefore addresses must remain valid.

Parameters
certCertificate address.
cert_lenCertificate length in bytes.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_STATE if method is called after calling connect().
MESH_ERROR_MEMORY in case of memory allocation failure.
mesh_error_t set_unicast_channel_function ( mesh_channel_function_t  channel_function,
uint16_t  fixed_channel = 0xffff,
uint8_t  dwell_interval = 0x00 
)

Set Wi-SUN FHSS unicast channel function parameters.

Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then device will restart network discovery after changing the channel function, fixed channel or dwell interval.

Function overwrites parameters defined by Mbed OS configuration.

Parameters
channel_functionChannel function. Fixed, TR51CF, DH1CF or vendor defined.
fixed_channelUsed channel when channel function is fixed channel. Use 0xffff when fixed channel function not on use.
dwell_intervalUsed dwell interval when channel function is TR51 or DH1. Use 0x00 to use leave parameter unchanged.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t stack_info_get ( ws_stack_state_t stack_info_ptr)

Get Wi-SUN Stack information.

Function reads Stack information from nanostack. Mesh interface must be initialized before calling this function.

Parameters
stack_info_ptrStructure given to stack where information will be stored
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t validate_broadcast_channel_function ( mesh_channel_function_t  channel_function,
uint16_t  fixed_channel,
uint8_t  dwell_interval,
uint32_t  broadcast_interval 
)

Validate Wi-SUN FHSS broadcast channel function parameters.

Function validates FHSS broadcast channel function parameters from mbed-mesh-api. Function can be used to test that values that will be used on set function are valid.

Parameters
channel_functionChannel function. Fixed, TR51CF, DH1CF or vendor defined.
fixed_channelUsed channel when channel function is fixed channel.
dwell_intervalUsed dwell interval when channel function is TR51 or DH1.
broadcast_intervalUsed broadcast interval.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t validate_channel_mask ( uint32_t  channel_mask[8])

Validate Wi-SUN FHSS channel mask.

Function validates FHSS channel mask. Function can be used to test that values that will be used on set function are valid.

Parameters
channel_maskValues defined in Wi-SUN management API. Channel mask bit field.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t validate_device_min_sens ( uint8_t  device_min_sens)

Validates Device minimum sensitivity.

Function validates device minimum sensitivity. Function can be used to test that values that will be used on set function are valid.

Parameters
device_min_sensDevice minimum sensitivity. Range 0-254.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t validate_network_name ( char *  network_name)

Validate Wi-SUN network name.

Function validates network name. Function can be used to test that values that will be used on set function are valid.

Parameters
network_nameNetwork name as NUL terminated string. Can't exceed 32 characters and can't be NULL.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t validate_network_regulatory_domain ( uint8_t  regulatory_domain,
uint8_t  operating_class,
uint8_t  operating_mode 
)

Validate Wi-SUN network regulatory domain, operating class and operating mode.

Function validates regulatory_domain, operating_class and operating_mode. Function can be used to test that values that will be used on set function are valid.

Parameters
regulatory_domainValues defined in Wi-SUN PHY-specification.
operating_classValues defined in Wi-SUN PHY-specification.
operating_modeValues defined in Wi-SUN PHY-specification.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t validate_network_size ( uint8_t  network_size)

Validate Wi-SUN network size.

Function validates network size from mbed-mesh-api. Function can be used to test that values that will be used on set function are valid.

Parameters
network_sizeNetwork size in hundreds of devices, 0x00 for network size certificate.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t validate_timing_parameters ( uint16_t  disc_trickle_imin,
uint16_t  disc_trickle_imax,
uint8_t  disc_trickle_k,
uint16_t  pan_timeout 
)

Validates Wi-SUN timing parameters.

Function validates timing parameters. Function can be used to test that values that will be used on set function are valid.

Parameters
disc_trickle_iminDiscovery trickle Imin. Range 1-255 seconds.
disc_trickle_imaxDiscovery trickle Imax. Range (2-2^8)*Imin.
disc_trickle_kDiscovery trickle k.
pan_timeoutPAN timeout; seconds; Range 60-15300 seconds.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
mesh_error_t validate_unicast_channel_function ( mesh_channel_function_t  channel_function,
uint16_t  fixed_channel,
uint8_t  dwell_interval 
)

Validate Wi-SUN FHSS unicast channel function parameters.

Function validates FHSS unicast channel function parameters. Function can be used to test that values that will be used on set function are valid.

Parameters
channel_functionChannel function. Fixed, TR51CF, DH1CF or vendor defined.
fixed_channelUsed channel when channel function is fixed channel.
dwell_intervalUsed dwell interval when channel function is TR51 or DH1.
Returns
MESH_ERROR_NONE on success.
MESH_ERROR_UNKNOWN in case of failure.
virtual WiFiInterface* wifiInterface ( )
virtualinherited

Return pointer to a WiFiInterface.

Returns
Pointer to requested interface type or NULL if this class doesn't implement the interface.

Reimplemented in WiFiInterface.

Definition at line 432 of file NetworkInterface.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.