Manual de usuario de i4uc

Introducción

Este manual explica en forma sencilla y comprensible el manejo de i4uc, desde como manipular archivos de texto sencillos hasta proyectos para luego ser grabados en un microcontrolador.

¿Qué es un IDE?

De  Wikipedia:

Un entorno de desarrollo integrado o, en inglés, Integrated Development Environment 
('IDE'), es un programa compuesto por un conjunto de herramientas para un 
programador.

Un IDE dedicado a microcontroladores debería tener los siguientes componentes:

1. Un editor de texto.
2. Un compilador.
3. Un intérprete.
4. Herramientas de automatización.
5. Un simulador (depuración).
6. Herramientas de grabación y lectura de microcontroladores.
7. Posibilidad de ofrecer un sistema de control de versiones.

El último componente es opcional para que el desarrollador disponga de un historial del proyecto en caso de que ocurran fallas severas o para retornar a un momento especial del proyecto que necesite revisarse.

Al momento de escribir este manual i4uc soporta todos componentes a excepción del 5 y 7. Futuras versiones podrían disponer de estos componentes.

Interfaz de usuario de i4uc

La interfaz de usuario de i4uc no es distinta a la de otras aplicaciones. La siguiente figura muestra la interfaz de usuario de i4uc al momento de ejecutarlo.

Esta interfaz de usuario presenta una barra de título (título de la aplicación, botones de maximizado, minimizado, cerrar), una barra de menús (archivo, editar, ver, etc.), una barra de herramientas con las opciones más utilizadas y el área de trabajo con paneles lateral, inferior y de documentos.

Barra de menús

En esta barra se encuentran todas las opciones de trabajo disponibles para el manejo de archivos, proyectos y programadores.

Menú Archivo

Dentro de este menú están las opciones para el manejo de los archivos de texto. Las opciones disponibles son:

• Nuevo: Crea un nuevo archivo de texto.
• Abrir: Abre un archivo de texto existente en el disco.
• Abrir reciente: Abre un archivo de texto recientemente empleado.
• Guardar: Guarda los cambios realizados a un archivo de texto.
• Guardar como: Guardar el archivo con un nuevo nombre.
• Imprimir: Imprime el archivo de texto actual.
• Configuración de página: Establece parámetros de impresión.
• Salir: Sale de i4uc.

Menú Editar

Aquí se encuentran las opciones de edición de los archivo de texto.

• Deshacer: Deshace la última operación realizada al archivo de texto.
• Rehacer: Rehace la última operación deshecha al archivo de texto.
• Cortar: Corta una porción de texto seleccionada del archivo de texto.
• Copiar: Copia una porción de texto seleccionada del archivo de texto.
• Pegar: Pega una porción de texto copiada o cortada al archivo de texto.
• Buscar: Aparece dentro del documento una una barra de busqueda y reemplazo.

Menú Ver

Opciones para visualización de paneles y elección de resaltado de código.

• Panel lateral: Muestra/Oculta el panel lateral.
• Panel inferior: Muestra/Oculta el panel inferior.
• Tipo de resaltado: Cambia el tipo de resaltado de sintaxis al archivo de texto.

Menú Documentos

Estas son opciones extras que permite manipular todos los documentos abiertos.

• Guardar todos: Guarda todos los documentos abiertos que fueron modificados.
• Cerrar todos: Cierra todos los documentos abiertos.

Menú Proyecto

Aquí se encuentran las opciones para manejar un proyecto de i4uc.

• Nuevo: Crea un nuevo proyecto y lo agrega al panel de proyectos.
• Abrir: Abre y agrega al panel de proyectos un proyecto existente.
• Abrir reciente: Abre un proyecto recientemente empleado.
• Agregar archivo: Agrega un nuevo archivo o importa uno externo al proyecto actual.
• Remover archivo del proyecto actual: Remueve un archivo existente en el proyecto actual.
• Remover archivo del perfil actual: Remueve un archivo existente en el perfil actual.
• Agregar perfil: Agrega un nuevo perfil o importa uno de otro proyecto.
• Editar perfil: Edita los parámetros del perfil actual.
• Duplicar perfil: Duplica el perfil actual.
• Remover perfil del proyecto actual: Remueve un perfil existente en el proyecto actual.
• Construir perfil: Construye el perfil actual.
• Limpiar prerfil: Elimina archivos generados durante la construcción del perfil actual.
• Detener: Detiene el proceso actual (construcción o limpieza).
• Cerrar proyecto: Cierra el proyecto actual.

Menú Programadores

Dentro de este menú se encuentran las opciones para manejar los programadores de microcontroladores.

• Escribir flash: Escribe el archivo .hex abierto a la memoria de flash del microcontrolador.
• Leer flash: Lee la memoria flash del microcontrolador a un archivo .hex.
• Verificar flash: Verifica la memoria flash del microcontrolador con el archivo .hex abierto.
• Borrar flash: Borra la memoria flash del microcontrolador.
• Escribir fusibles: Escribir los fusibles al microcontrolador.
• Leer fusibles: Leer los fusibles del microcontrolador.
• Obtener versión del programador: Obtiene la versión del programador.
• Detener: Detiene algún proceso de lectura/escritura del/al microcontrolador.

Manejo de documentos

El manejo de documentos en i4uc no es diferente a la de otros editores de textos por lo que las operaciones de creación, apertura, guardado, impresión y edición no son diferentes a la de otros editores de uso común (gedit, notepad, kate, etc.).

Documento se refiere a los archivos de texto en general pero algunos archivos durante su apertura son procesados para su adecuada visualización y utilización. Un ejemplo claro serán los archivos .hex que serán procesados para ser visualizados en un visor de archivos .hex.

También es posible editar ciertos parámetros de visualización de los documentos, uno de ellos es el Tipo de resaltado disponible desde el menú Ver. Esta opción permite elegir el tipo de resaltado de sintaxis para el documento. Al momento de abrir un documento se detecta el tipo de sintaxis del contenido del documento y se elige el resaltado mas adecuado. Si el usuario desea cambiarlo, podrá hacerlo desde el menú Ver, opción Tipo de resaltado.

Otros parámetros como la tipografía, ancho de tabulación, número de línea y otros más estás disponibles en el Panel lateral, solapa Preferencias.

Las opciones disponibles son las siguientes:

• Tipografía: Permite elegir el tipo y tamaño de letra a usar por los documentos.
• Ancho de tabulación: Cantidad de espacios que representará una tabulación.
• Sangría automática: Al insertar una línea el editor mantienen la sangría de la línea anterior.
• Resaltar línea actual: Resalta o no la línea en donde se encuentra el cursor.
• Insertar espacios en vez de tabulaciones: Inserta espacios indicado por el ancho de tabulación en lugar de tabulaciones.
• Mostrar número de línea: Muestra en el borde izquierdo del documento los números de líneas.
• Resaltar pareja de corchetes: Al activar esta opción y al situar el cursor en un corchete, paréntesis o llaves el editor resalta el corchete, paréntesis o llave opuesto.
• Habilitar ajuste de texto: Al activar esta opción todo el texto es ajustado al ancho del editor.

Manejo de proyectos

Esta sección explica como manipular proyectos en i4uc. Se explica como crear, abrir, editar, agregar/quitar archivo y construir proyectos.

Crear un proyecto

Para crear un proyecto de i4uc se debe ir al menú Proyecto y elegir la opción Nuevo o presionar las teclas control+shift+n. Se abrirá una página con la siguiente interfaz.

La lista desplegable con etiqueta Carpeta: permite elegir la carpeta en donde se guardará el proyecto. Por defecto la carpeta elegida es la carpeta del usuario.

En la entrada de texto con etiqueta Nombre: se debe colocar el nombre del proyecto a crear, este puede ser corto para una rápida identificación.

Luego se agregan él o los autores del proyecto. Para agregar un autor simplemente hacer se elige la opción Añadir, aparecerá un cuadro de diálogo (vea la siguiente figura) en el que se escribe el nombre del autor. El nombre puede ser escrito de cualquier manera, puede ser por ejemplo "Matias De la Puente" o también "Matias De la Puente <mfpuente.ar@…>" si se desea introducir algún contacto con él o los autores. Se acepta la entrada y en la lista de autores figura el autor recién creado.

Para eliminar un autor simplemente se selecciona aquel que desea eliminarse y se elige la opción Quitar.

Al elegir la opción Aceptar, el proyecto será creado en la carpeta elegida con el nombre indicado anteriormente. A continuación el proyecto será abierto dentro del Panel lateral, solapa Proyectos. Si el panel no puede verse elegir del menú ver, opción Panel lateral o F9.

Por defecto, a los proyectos recien creados se agrega automáticamente un perfil llamado main. Este perfil puede ser usado como el perfil principal, en donde se construye el perfil que representa por completo al proyecto. Puede cambiar el nombre o eliminar este perfil.

Abrir un proyecto existente

Para abrir un proyecto existente simplemente se elige dentro del menú Proyecto, opción Abrir o presionando las teclas control+shift+o. Se elige el archivo del proyecto, preferentemente con extensión .i4uc.

También es posible abrir proyectos recientemente empleados desde el menú Proyecto, opción Abrir reciente.

Agregar/Remover archivos al proyecto

Una vez creado o abierto un proyecto es posible agregarle archivos nuevos o importados. Para crear o importar archivos hay que elegir dentro del menú Proyectos la opción Agregar archivo. Un cuadro de dialogo (ver figura) permitirá realizar algunas operaciones.

Para crear un archivo se introduce en la entrada de texto con etiqueta Nuevo archivo: el nombre del archivo a crear. Al elegir Aceptar el archivo será creado dentro de la carpeta de proyecto. A continuación, el archivo es agregado al proyecto actual y también es abierto para su edición.

Para importar un archivo existente se elige la opción Importar archivo y se abre el cuadro de dialogo para elegir el archivo a importar. Si el archivo se encuentra fuera de la carpeta del proyecto se le preguntará al usuario si desea copiarlo a la carpeta del proyecto. Al elegir la opción Aceptar el archivo es agregado al proyecto actual y también es abierto para su edición.

También es posible asociar el archivo a agregar a un perfil. Para ello debe elegirse los perfiles a los que pertenecerá el archivo.

Nota:

Todos los archivo que pertenecen a un proyecto deben encontrarse dentro de la 
misma carpeta del proyecto, esto simplemente es para facilitar el transporte y 
construcción del proyecto.

Los archivos pueden ser removidos del proyecto actual o de algun perfil. Para remover un archivo del proyecto actual hay que primero seleccionar el archivo en el panel de proyectos luego elegir del menú Proyectos la opción Remover archivo del proyecto actual. Para remover un archivo del perfil actual hay que primero seleccionar el archivo en el panel de proyectos luego elegir del menú Proyectos la opción Remover archivo del perfil actual

Construir y limpiar un perfil

Antes de construir un perfil, debe elegirse el tipo de contructor que será empleado para generar el archivo .hex.

Para construir un perfil de i4uc primero hay que seleccionar un perfil en el panel de proyecto y luego se elige dentro del menú Proyecto la opción Construir perfil o presionando las teclas control+shift+b. El proceso de construcción del proyecto puede verse en el panel inferior (si este no es visible elegir del menú Ver la opción Panel inferior). Si el proceso sufre algún inconveniente y es necesario detenerlo se elige dentro del menú Proyecto la opción Detener.

El proceso de construcción del perfil puede generar archivos que no pertenezcan al proyecto, i4uc esta al tanto de estos archivo y puede eliminarlos eligiendo dentro del menú Proyecto la opción Limpiar perfil.

Manejo de programadores

El manejo de los programadores se lleva a cabo de una forma particular. En primer lugar se elige el programador a utilizar y sus parámetros desde el Panel lateral solapa Programadores. Por el momento i4uc soporta estos programadores:

• Picstart Plus: Programador por puerto serial de la empresa Microchip próximo a estar en desuso. El soporte para este programador es a través del comando picp disponible  aquí. Permite programar alrededor de 170 dispositivos (entre memorias EEPROM y microcontroladores PIC).
• Pickit 2: Programador por puerto USB también de la empresa Microchip. Es soportado empleando el comando pk2cmd el cual es mantenido por Microchip. Permite programar alrededor de 532 dispositivos (entre memorias EEPROM y microcontroladores PIC). Se encuentra disponible desde la versión 0.4.0 de i4uc.

Nota sobre otros programadores:

Actualmente se da soporte a estos programadores pero también a futuro se dará 
soporte a otros programadores, sobre todo aquellos destinados a los 
microcontroladores de Atmel y ARM.

Picstart Plus

Como se ha sido mencionado anteriormente, el soporte para el programador Picstart Plus es realizado a través del comando picp. Para trabajar con este programador, en primer lugar debe ser elegido dentro del Panel lateral solapa Programadores.

Configurar el Picstart Plus

A continuación se deben verificar ciertos parámetros del programador. Las opciones de configuran para este programador puede verse en la siguiente figura.

En primer lugar hay que elegir el Puerto serie, es decir el puerto al que está conectado el programador. La opción Actualizar a la derecha sirve para actualizar la lista de puertos seriales disponibles en el sistema (dispositivos USB a Puerto Serial). Esta opción únicamente tiene efecto en sistemas GNU/Linux empleando hal.

Se elige a continuación el Dispositivo a programar eligiéndolo de la lista desplegable. Si el dispositivo no figura en la lista el programador no puede programarlo.

Se especifican los Fusibles a programar al microcontrolador PIC si así se lo desea.

Programar con Picstart Plus

Luego de ajustar los parámetros del programador es posible escribir/leer/verificar/borrar la memoria flash del microcontrolador, escribir/leer los fusibles y obtener la versión del programador. Todas estas acciones se encuentran dentro del menú Programadores.

Para escribir en la memoria flash del microcontrolador hay que abrir un archivo .hex y elegir la opción Escribir flash.

Para leer la memoria flash del microcontrolador a un archivo .hex se elige la opción Leer flash.

Para verificar la memoria flash del microcontrolador hay que abrir el archivo .hex a verificar y elegir la opción Verificar flash.

Para borrar la memoria flash del microcontrolador se elige la opción Borrar flash.

Para escribir los fusibles al microcontrolador se elige la opción Escribir fusibles.

Para leer los fusibles del microcontrolador se elige la opción Leer fusibles. Los fusibles leídos son mostrados en el Panel de inferior, solapa Registro de programadores.

Para obtener la versión del programador conectado se elige la opción Obtener versión del programador.

Puede ocurrir que alguna operación deba ser detenida en forma abrupta por el usuario. Para ello se elige la opción detener.

Las acciones del programador no se activarán si las opciones de configuración no están correctamente elegidas o si el programador no soporta dicha acción.

Pickit 2

Como se ha sido mencionado anteriormente, el soporte para el programador Pickit 2 es realizado a través del comando pk2cmd. Para trabajar con este programador, en primer lugar debe ser elegido dentro del Panel lateral solapa Programadores.

Configurar el Pickit 2

A continuación se deben verificar ciertos parámetros del programador. Las opciones de configuran para este programador puede verse en la siguiente figura.

Se debe elegir en primer lugar la carpeta en donde se encuentra el archivo de dispositivos este archivo es necesario ya que contiene toda la información necesaria para programar los microcontroladores.

Se elige a continuación el Dispositivo a programar eligiéndolo de la lista desplegable. Si el dispositivo no figura en la lista el programador no puede programarlo.

Programar con Pickit 2

Luego de ajustar los parámetros del programador es posible escribir/leer/verificar/borrar la memoria flash del microcontrolador, leer los fusibles y obtener la versión del programador. Todas estas acciones se encuentran dentro del menú Programadores.

Para escribir en la memoria flash del microcontrolador hay que abrir un archivo .hex y elegir la opción Escribir flash.

Para leer la memoria flash del microcontrolador a un archivo .hex se elige la opción Leer flash.

Para verificar la memoria flash del microcontrolador hay que abrir el archivo .hex a verificar y elegir la opción Verificar flash.

Para borrar la memoria flash del microcontrolador se elige la opción Borrar flash.

Con este programador no es posible escribir los fusibles en forma directa. Es necesario hacerlo a través del archivo .hex.

Para leer los fusibles del microcontrolador se elige la opción Leer fusibles. Los fusibles leídos son mostrados en el Panel de inferior, solapa Registro de programadores.

Para obtener la versión del programador conectado se elige la opción Obtener versión del programador.

Puede ocurrir que alguna operación deba ser detenida en forma abrupta por el usuario. Para ello se elige la opción detener.

Las acciones del programador no se activarán si las opciones de configuración no están correctamente elegidas o si el programador no soporta dicha acción.

Ejemplo de aplicación

Este ejemplo demostrará como crear un sencillo proyecto en i4uc. En concreto, se realizará un oscilador con el microcontrolador PIC16F887 de la empresa Microchip. La oscilación será realizada a través del pin RD0.

Creación de un proyecto

Para crear el proyecto elegir dentro del menú Proyecto la opción Nuevo. Ajustar los parámetros según se observa en la figura.

La carpeta ejemplo puede estar ubicada en cualquier lugar.

Elegir la opción Aceptar, el proyecto será creado en disco y abierto dentro del Panel lateral, solapa Proyectos como se observa en la figura.

Si no se observa esta pantalla es debido a que el panel lateral se encuentra oculto, para mostrarlo elegir dentro del menú Ver la opción Panel lateral.

Desarrollo de un proyecto

Para desarrollar un proyecto primero hay que agregar archivos. Para este ejemplo de aplicación se creará un archivo llamado main.c. Elegir del menú Proyecto la opción Agregar archivo e introducir main.c en la entrada de texto de la opción Nuevo Archivo. Elija el perfil main para que el archivo pertenezca a ese perfil.

Elegir Aceptar y el archivo será creado en el disco, agregado al proyecto, al perfil main y abierto para su edición.

Para este ejemplo se elige main.c como nombre pero puede elegirse cualquier otro, pero obviamente con extensión .c. Al momento de construir el programa solo importa que exista la función main ().

Escribir el siguiente programa dentro de main.c.

Guardar el archivo main.c y proceder con la construcción del perfil main.

Construcción del perfil

La construcción es bastante sencilla basta únicamente elegir dentro del Panel lateral, solapa Proyectos, solapa perfiles (esta solapa tiene un icono de carpeta y se encuentra en la parte inferior del panel lateral) el constructor del perfil main (vea la figura). Luego se elige en el menú Proyectosla opción Construir perfil para iniciar el proceso de construcción.

Si ocurre un error de compilación, en el registro puede verse en que archivo y en que línea ocurrió el error.

Nota.

Por el momento i4uc no procesa los mensaje de error, esto quiere decir que al 
ocurrir un error y al hacer doble-click sobre el mensaje de error i4uc no saltará 
a la línea donde ocurre el error. Futuras versiones podrán realizar este proceso.

Si no hay problemas en la construcción del proyecto se realiza ahora el grabado del perfil dentro del microcontrolador.

Grabar un archivo .hex dentro de un microcontrolador

Para grabar un archivo .hex dentro de un microcontrolador hay que primero elegir un programador y luego configurarlo. Para este caso se elige el programador Pickit 2. Ajustar los parámetros guiándose de la siguiente figura.

Ahora para grabar el microcontrolador hay que elegir del menú Programadores la opción Escribir flash. Si no hay errores el archivo .hex esta guardado dentro del microcontrolador.

NOTA:

Puede conectarse este programador en cualquier momento del proceso de grabación 
pero antes de ejecutar cualquier operación. Por supuesto si por el error el 
programador no es conectado, en el registro se muestra dicha situación.