alias

Functions
bool	set (char *buf, uint32_t len)
bool	get (char *buf, uint32_t len)

Detailed Description

Function Documentation

set()

bool set	(	char *	buf,
		uint32_t	len
	)

Description

Set the alias name for device.

Syntax

api.system.alias.set(buf, len)

Parameters

buf	the buffer to set alias name
len	the length of alias name( <= 16 bytes)

Returns

bool

Return values

TRUE	for setting alias name successfully
FALSE	for setting alias name failure

Example

     void setup()
     {
         Serial.begin(115200);
         api.system.alias.set("my device",16);
         char buf[16];
         Serial.println(api.system.alias.get(buf,16));
         Serial.println(buf);
     }
     void loop()
     {
     }

get()

bool get	(	char *	buf,
		uint32_t	len
	)

Description

Set the alias name for device.

Syntax

api.system.alias.get(buf, len)

Parameters

buf	the buffer to get alias name
len	the length of alias name( <= 16 bytes)

Returns

bool

Return values

TRUE	for getting alias name successfully
FALSE	for getting alias name failure

Example

     void setup()
     {
         Serial.begin(115200);
         api.system.alias.set("my device",16);
         char buf[16];
         Serial.println(api.system.alias.get(buf,16));
         Serial.println(buf);
     }
     void loop()
     {
     }