api.h File Reference

API com defines essenciais para a CLI. More...

Go to the source code of this file.

Data Structures
struct	str_t
	str_t More...
struct	cli_str
	cli_str More...
Defines
#define	TAM_STRING   30
	tamanho das strings usado na CLI
#define	TAM_STRING_LONG   100
#define	MAX_COMMAND_SIZE   150
#define	MAX_RESP_SIZE   200
#define	MAX_TAM_SIZE_STRING   2000
#define	CLI_PROMPT   "\nTCCOS> "
	Chamada do terminal.
#define	uipMAC_ADDR0   0x0
#define	uipMAC_ADDR1   0xbd
#define	uipMAC_ADDR2   0x33
#define	uipMAC_ADDR3   0x02
#define	uipMAC_ADDR4   0x64
#define	uipMAC_ADDR5   0x24
Typedefs
typedef unsigned char	U08_t
typedef unsigned long	U32_t
typedef unsigned long long	U64_t
Enumerations
enum	break_t { RET_OK = 0 }
	tipo break_t More...
enum	type_t { GET_CMD = 0, SET_CMD, HELP_CMD, CHAT_CMD }
	type_t More...
Functions
break_t	do_get_temperature (str_t *tp)
	Funcao que retorna a temperatura ambiente.
break_t	do_IP (str_t *tp)
	Funcao da CLI para configuracao do IP.
break_t	do_gateway (str_t *tp)
	Funcao da CLI paraconfiguracao do Gateway.
break_t	do_mask (str_t *tp)
	Funcao da CLi para configuracao da mascara de rede.
break_t	do_MAC (str_t *tp)
	Funcao que permite ver o endereco MAC.
break_t	do_init (str_t *tp)
	Mensagem inicial da serial.
break_t	do_lcd (str_t *tp)
	Permite escrever uma mensagem no LCD.
break_t	do_chat (str_t *tp)
	Comando da CLI para chamada do Chat.
break_t	do_configIp (str_t *tp)
	Funcao da CLI que retorna enderecos da rede.
break_t	do_ftp (str_t *tp)
	Funcao para conectar como FTP Client.
Variables
int	uipIP_ADDR0
int	uipIP_ADDR1
int	uipIP_ADDR2
int	uipIP_ADDR3
unsigned short	uip_GAT0
unsigned short	uip_GAT1
unsigned short	uip_GAT2
unsigned short	uip_GAT3
unsigned short	uip_Mask0
unsigned short	uip_Mask1
unsigned short	uip_Mask2
unsigned short	uip_Mask3
int	vectorAddrIPv4 [4]

---

Detailed Description

Author:

Marco Tulio Martins

Definition in file api.h.

---

Define Documentation

#define CLI_PROMPT   "\nTCCOS> "

Nome do comando de entrada do terminal.

Definition at line 33 of file api.h.

#define MAX_COMMAND_SIZE   150

Definition at line 16 of file api.h.

#define MAX_RESP_SIZE   200

Definition at line 17 of file api.h.

#define MAX_TAM_SIZE_STRING   2000

Definition at line 19 of file api.h.

#define TAM_STRING   30

Definition at line 14 of file api.h.

#define TAM_STRING_LONG   100

Definition at line 15 of file api.h.

#define uipMAC_ADDR0   0x0

Definition at line 36 of file api.h.

#define uipMAC_ADDR1   0xbd

Definition at line 37 of file api.h.

#define uipMAC_ADDR2   0x33

Definition at line 38 of file api.h.

#define uipMAC_ADDR3   0x02

Definition at line 39 of file api.h.

#define uipMAC_ADDR4   0x64

Definition at line 40 of file api.h.

#define uipMAC_ADDR5   0x24

Definition at line 41 of file api.h.

---

Typedef Documentation

typedef unsigned char U08_t

Definition at line 22 of file api.h.

typedef unsigned long U32_t

Definition at line 23 of file api.h.

typedef unsigned long long U64_t

Definition at line 24 of file api.h.

---

Enumeration Type Documentation

enum break_t

Usado para o retorna das funcoes da CLI.

Enumerator:

RET_OK

Definition at line 66 of file api.h.

enum type_t

Configura o tipo de comando solicitado pela CLI

Enumerator:

GET_CMD
SET_CMD
HELP_CMD
CHAT_CMD

Definition at line 77 of file api.h.

---

Function Documentation

break_t do_chat

(

str_t *

tp

)

Comando usado para inicializar o chat Deve ser passado como parametro junto ao comando a porta de acesso que sera usado no display.

Returns:

RET_OK para execucao com sucesso da funcao

Definition at line 100 of file cli_func.c.

Here is the call graph for this function:

break_t do_configIp

(

str_t *

tp

)

Funcao que permite gera como retorno o endereco de Mascara, Gateway e IP.

Definition at line 417 of file cli_func.c.

Here is the call graph for this function:

break_t do_ftp

(

str_t *

tp

)

Funcao para conexao como FTP Client

Descontinuado pois o kit possui pouca memória para armazenamento de arquivo para transmissao.

Parameters:

tp

Estrutura com os dados para interpretacao do comando.

Returns:

RET_OK para execucao com sucesso da funcao ou RET_ERROR

Definition at line 457 of file cli_func.c.

Here is the call graph for this function:

break_t do_gateway

(

str_t *

tp

)

Funcao permite ler e alterar endereco do gateway

Parameters:

tp

Estrutura com os dados para interpretacao do comando.

Returns:

RET_OK para execucao com sucesso da funcao ou RET_ERROR

Definition at line 316 of file cli_func.c.

Here is the call graph for this function:

break_t do_get_temperature

(

str_t *

tp

)

Funcao que le a temperatura do sensor de temperatura presente no kit e retorna para quem solicitou

Returns:

RET_OK para execucao com sucesso da funcao

Definition at line 84 of file cli_func.c.

break_t do_init

(

str_t *

tp

)

-------------------------------------------

• TCC - UIP MULTIPLE APLICATION - ------------------------------------------- *

  Returns:

  RET_OK para execucao com sucesso da funcao

Definition at line 68 of file cli_func.c.

Here is the call graph for this function:

break_t do_IP

(

str_t *

tp

)

Funcao para ler ou alterar o endereco de IP.

Parameters:

tp

Estrutura com os dados para interpretacao do comando.

Returns:

RET_OK para execucao com sucesso da funcao ou RET_ERROR

Definition at line 193 of file cli_func.c.

Here is the call graph for this function:

break_t do_lcd

(

str_t *

tp

)

Escreve mensagem no display 16x2 Funcao permite apenas comandos de SET.

Parameters:

tp

Estrutura com os dados para interpretacao do comando.

Returns:

RET_OK para execucao com sucesso da funcao ou RET_ERROR

Definition at line 256 of file cli_func.c.

Here is the call graph for this function:

break_t do_MAC

(

str_t *

tp

)

Faz leitrura do endereco MAC do Kit Funcao de leitura apenas.

Returns:

RET_OK para execucao com sucesso da funcao

Definition at line 174 of file cli_func.c.

Here is the call graph for this function:

break_t do_mask

(

str_t *

tp

)

Funcao permite ler ou alterar o endereco de mascara.

Parameters:

tp

Estrutura com os dados para interpretacao do comando.

Returns:

RET_OK para execucao com sucesso da funcao ou RET_ERROR

Definition at line 374 of file cli_func.c.

Here is the call graph for this function:

---

Variable Documentation

unsigned short uip_GAT0

Definition at line 49 of file api.h.

unsigned short uip_GAT1

Definition at line 50 of file api.h.

unsigned short uip_GAT2

Definition at line 51 of file api.h.

unsigned short uip_GAT3

Definition at line 52 of file api.h.

unsigned short uip_Mask0

Definition at line 54 of file api.h.

unsigned short uip_Mask1

Definition at line 55 of file api.h.

unsigned short uip_Mask2

Definition at line 56 of file api.h.

unsigned short uip_Mask3

Definition at line 57 of file api.h.

int uipIP_ADDR0

Definition at line 44 of file api.h.

int uipIP_ADDR1

Definition at line 45 of file api.h.

int uipIP_ADDR2

Definition at line 46 of file api.h.

int uipIP_ADDR3

Definition at line 47 of file api.h.

int vectorAddrIPv4[4]

Definition at line 85 of file api.h.