Referencia del Archivo shell_commands.h

Define la interfaz pública del módulo shell_commands. Se definen estructuras para listar los comandos y los usuarios. Más...

Ir al código fuente de este archivo.

Estructuras de datos
struct	shell_command
struct	cell_phone

Funciones
void	activate (unsigned int argc, char **argv)
	Función que habilita el envío de notificaciones vía SMS. Envía al usuario un SMS de confirmación.
void	deactivate (unsigned int argc, char **argv)
	Función que inhabilita el envío de notificaciones vía SMS. Envía al usuario un SMS de confirmación.
void	send1 (unsigned int argc, char **argv)
	Función que envía una notificación vía SMS al celular configurado como primario.
void	send2 (unsigned int argc, char **argv)
	Función que envía una notificación vía SMS al celular configurado como secundario.
void	location (unsigned int argc, char **argv)
	Función NO IMPLEMENTADA AÚN que determina y notifica al usuario la ubicación actual según indique el GPS.
void	credit (unsigned int argc, char **argv)
	Función NO IMPLEMENTADA que averigua con el proveedor de servicios cual es el saldo restante en el chip usado y se lo notifica al usuario vía SMS.
void	setTime (unsigned int argc, char **argv)
	Función que modifica la ventana de tiempo entre las notificaciones. Se espera el parámetro esté dado en minutos. Se considera además que los tiempos entre notificaciones son los mismos tanto para avisos entre 1er SMS y llamada, como entre llamada y 2º SMS.
void	help (unsigned int argc, char **argv)
	Función que devuelve en un SMS la lista con todos los comandos disponibles al momento. También, si se le pasa un comando como parámetro, devuelve la descripción del mismo o error si no existe.
void	showConfig (unsigned int argc, char **argv)
	Función que envía un SMS con los parámetros de configuración actual. Esto es: estado de notificaciones, celulares primario y secundario, y tiempo entre notificaciones.
void	addUser (unsigned int argc, char **argv)
	Función que agrega el usuario pasado como parámetro a la lista de usuarios habilitados a interactuar con el sistema.
void	deleteUser (unsigned int argc, char **argv)
	Función que elimina el usuario pasado como parámetro de la lista de usuarios habilitados a interactuar con el sistema.
void	showUser (unsigned int argc, char **argv)
	Función que envía un SMS con el listado de usuarios habilitados a interactuar con el sistema.

---

Descripción detallada

Define la interfaz pública del módulo shell_commands. Se definen estructuras para listar los comandos y los usuarios.

Autor:

Juan Martín Ortega, Ramiro Barrón, Andrea Cukerman

Fecha:

Junio 2012

Definición en el archivo shell_commands.h.

---

Documentación de las funciones

void activate	(	unsigned int	argc,
		char **	argv
	)

Función que habilita el envío de notificaciones vía SMS. Envía al usuario un SMS de confirmación.

Parámetros:

argc	Cantidad de parámetros.
argv	Parámetros del comando.

Definición en la línea 93 del archivo shell_commands.c.

void addUser	(	unsigned int	argc,
		char **	argv
	)

Función que agrega el usuario pasado como parámetro a la lista de usuarios habilitados a interactuar con el sistema.

Parámetros:

argc	Cantidad de parámetros.
argv	Parámetros del comando.

Definición en la línea 288 del archivo shell_commands.c.

void credit	(	unsigned int	argc,
		char **	argv
	)

Función NO IMPLEMENTADA que averigua con el proveedor de servicios cual es el saldo restante en el chip usado y se lo notifica al usuario vía SMS.

Parámetros:

argc	Cantidad de parámetros.
argv	Parámetros del comando.

Definición en la línea 205 del archivo shell_commands.c.

void deactivate	(	unsigned int	argc,
		char **	argv
	)

Función que inhabilita el envío de notificaciones vía SMS. Envía al usuario un SMS de confirmación.

Parámetros:

argc	Cantidad de parámetros.
argv	Parámetros del comando.

Definición en la línea 106 del archivo shell_commands.c.

void deleteUser	(	unsigned int	argc,
		char **	argv
	)

Función que elimina el usuario pasado como parámetro de la lista de usuarios habilitados a interactuar con el sistema.

Parámetros:

argc	Cantidad de parámetros.
argv	Parámetros del comando.

Definición en la línea 335 del archivo shell_commands.c.

void help	(	unsigned int	argc,
		char **	argv
	)

Función que devuelve en un SMS la lista con todos los comandos disponibles al momento. También, si se le pasa un comando como parámetro, devuelve la descripción del mismo o error si no existe.

Parámetros:

argc	Cantidad de parámetros.
argv	Parámetros del comando.

Definición en la línea 219 del archivo shell_commands.c.

void location	(	unsigned int	argc,
		char **	argv
	)

Función NO IMPLEMENTADA AÚN que determina y notifica al usuario la ubicación actual según indique el GPS.

Parámetros:

argc	Cantidad de parámetros.
argv	Parámetros del comando.

Definición en la línea 193 del archivo shell_commands.c.

void send1	(	unsigned int	argc,
		char **	argv
	)

Función que envía una notificación vía SMS al celular configurado como primario.

Parámetros:

argc	Cantidad de parámetros.
argv	Parámetros del comando.

Definición en la línea 118 del archivo shell_commands.c.

void send2	(	unsigned int	argc,
		char **	argv
	)

Función que envía una notificación vía SMS al celular configurado como secundario.

Parámetros:

argc	Cantidad de parámetros.
argv	Parámetros del comando.

Definición en la línea 139 del archivo shell_commands.c.

void setTime	(	unsigned int	argc,
		char **	argv
	)

Función que modifica la ventana de tiempo entre las notificaciones. Se espera el parámetro esté dado en minutos. Se considera además que los tiempos entre notificaciones son los mismos tanto para avisos entre 1er SMS y llamada, como entre llamada y 2º SMS.

Parámetros:

argc	Cantidad de parámetros.
argv	Parámetros del comando.

Definición en la línea 170 del archivo shell_commands.c.

void showConfig	(	unsigned int	argc,
		char **	argv
	)

Función que envía un SMS con los parámetros de configuración actual. Esto es: estado de notificaciones, celulares primario y secundario, y tiempo entre notificaciones.

Parámetros:

argc	Cantidad de parámetros.
argv	Parámetros del comando.

Definición en la línea 262 del archivo shell_commands.c.

void showUser	(	unsigned int	argc,
		char **	argv
	)

Función que envía un SMS con el listado de usuarios habilitados a interactuar con el sistema.

Parámetros:

argc	Cantidad de parámetros.
argv	Parámetros del comando.

Definición en la línea 389 del archivo shell_commands.c.