Capítulo 2: Tu entorno de trabajo

Capítulo 2: Tu entorno de trabajo

Parte I - Sección 1: Introducción - Nivel: Principiante

---

Objetivos de aprendizaje

Al finalizar este capítulo serás capaz de:

• Configurar correctamente las carpetas de scripts en EPLAN
• Elegir y configurar un editor de texto adecuado
• Entender la estructura básica de un script EPLAN
• Ejecutar tu primer script “Hello World” en EPLAN
• Configurar el entorno para el resto del libro

---

Requisitos previos

Antes de comenzar este capítulo debes:

• Tener instalado EPLAN Electric P8 (versión 2020 o superior)
• Haber leído el Capítulo 1 y estar motivado para empezar

---

Proyecto del capítulo

Tu primer script funcional en EPLAN

Al final de este capítulo habrás ejecutado tu primer script que mostrará un mensaje en EPLAN. No entenderás todavía el código (eso viene después), pero verás que SÍ puedes hacer que EPLAN ejecute tus instrucciones.

Tiempo estimado: 30-45 minutos

---

Contenido

1. Introducción

Antes de escribir código, necesitas preparar tu espacio de trabajo. Piensa en esto como organizar tu taller antes de empezar un proyecto: necesitas saber dónde están tus herramientas, cómo acceder a ellas, y tener todo ordenado.

En este capítulo configuraremos:

1. Carpetas de scripts: Dónde guardar tus archivos .cs
2. Editor de texto: Dónde escribir código cómodamente
3. EPLAN: Cómo ejecutar scripts desde la interfaz

---

2. Versión de EPLAN

2.1 Diferencias entre versiones

Si tienes una versión más antigua (2020-2025):

• La mayoría del código funcionará igual
• Puede haber pequeñas diferencias en nombres de métodos
• Algunas funcionalidades nuevas no estarán disponibles

Si encuentras alguna incompatibilidad, revisa la documentación de tu versión.

---

3. Estructura de carpetas para scripts

EPLAN puede ejecutar scripts desde varias ubicaciones. Vamos a crear una estructura organizada que usaremos durante todo el libro.

3.1 Carpeta principal de scripts

Para facilitar el seguimiento de los ejemplos de este libro, recomendamos crear una estructura de carpetas estándar en la raíz de tu disco.

Crea la siguiente estructura:

Carpeta local:

C:\EPLAN_Scripts\
├── Aprendizaje\        (scripts de este libro)
├── Produccion\         (scripts terminados y probados)
├── Backup\             (respaldos)
└── Recursos\           (archivos auxiliares)

¿Por qué esta estructura?

• Aprendizaje\: Scripts de práctica, experimentación
• Produccion\: Scripts validados y listos para usar en proyectos reales
• Backup\: Versiones anteriores por si algo sale mal
• Recursos\: Plantillas, archivos de configuración, imágenes, etc.

3.2 Configurar EPLAN para encontrar tus scripts

EPLAN necesita saber dónde buscar tus scripts:

1. Abre EPLAN
2. Ve a Fichero > Ajustes > Usuario > Gestión > Directorios
3. En “Scripts”, añade tu carpeta

Ahora EPLAN buscará scripts en esa carpeta.

---

4. Editor de texto

Necesitas un editor de texto para escribir código. NO uses Notepad (bloc de notas de Windows) porque no tiene resaltado de sintaxis ni autocompletado.

4.1 Opciones recomendadas

Opción 1: Visual Studio Code (Recomendado)

Ventajas:

• Gratuito y ligero
• Resaltado de sintaxis para C#
• Extensiones útiles
• Terminal integrado
• IntelliSense (autocompletado inteligente)

Descargar: https://code.visualstudio.com/

Configuración básica:

1. Instalar Visual Studio Code
2. Abrir VS Code
3. Instalar extensión “C#” de Microsoft:
   • Clic en el icono de extensiones (cuadrado con 4 cuadrados pequeños)
   • Buscar “C#”
   • Instalar “C# for Visual Studio Code”

Opción 2: Notepad++

Ventajas:

• Muy ligero
• Resaltado de sintaxis básico
• Gratuito

Desventajas:

• No tiene IntelliSense
• Menos funcionalidades que VS Code

Descargar: https://notepad-plus-plus.org/

Opción 3: Visual Studio Community

Ventajas:

• IDE completo y profesional
• Mejor IntelliSense
• Debugging avanzado

Desventajas:

• Muy pesado (varios GB)
• Overkill para scripts simples
• Tiempo de instalación largo

Recomendación: Usa Visual Studio Code para este libro. Es el mejor balance entre funcionalidad y peso.

4.2 Configurar VS Code para EPLAN

Una vez instalado VS Code:

1. Abre VS Code
2. Ve a Archivo > Abrir carpeta
3. Selecciona C:\EPLAN_Scripts\Aprendizaje
4. Esta será tu carpeta de trabajo

Tip: Crea un acceso directo de VS Code con esta carpeta ya abierta para ahorrar tiempo.

---

5. Estructura de un script EPLAN

Antes de escribir tu primer script, veamos cómo luce un script EPLAN mínimo:

using System;
using Eplan.EplApi.Base;
using Eplan.EplApi.ApplicationFramework;

public class MiPrimerScript
{
    [Start]
    public void Ejecutar()
    {
        // Tu código aquí
        MessageBox.Show("Hola desde EPLAN!", "Mi Primer Script");
    }
}

No te preocupes por entender cada línea todavía. Pero aquí está la estructura básica:

5.1 Sección de “using”

using System;
using Eplan.EplApi.Base;
using Eplan.EplApi.ApplicationFramework;

¿Qué hace?: Le dice a C# qué librerías (conjuntos de código preescrito) vas a usar.

Analogía: Es como decir “voy a usar herramientas de la caja roja y de la caja azul” antes de empezar un trabajo.

Las librerías más comunes para EPLAN son:

• System: Funcionalidades básicas de C#
• Eplan.EplApi.Base: Clases fundamentales de EPLAN
• Eplan.EplApi.ApplicationFramework: Interfaz con la aplicación EPLAN

5.2 Declaración de clase

public class MiPrimerScript
{
    // Contenido
}

¿Qué es una clase?: Por ahora, piénsalo como un “contenedor” de código. Todo el código de tu script vive dentro de una clase.

Regla importante: El nombre de la clase debe ser descriptivo de lo que hace el script.

5.3 Método con atributo [Start]

[Start]
public void Ejecutar()
{
    // Tu código
}

[Start]: Le dice a EPLAN “empieza ejecutando este método”.

public void Ejecutar(): Define un método (función) llamado “Ejecutar”.

Entre llaves { }: Va todo el código que quieres que se ejecute.

---

6. Tu primer script: Hello World

Ahora sí, vamos a crear tu primer script funcional.

Paso 1: Crear el archivo

1. Abre tu editor de texto (VS Code)
2. Crea un nuevo archivo:
   • En VS Code: Archivo > Nuevo archivo
   • O presiona Ctrl + N
3. Guarda el archivo como: C:\EPLAN_Scripts\Aprendizaje\HelloWorld.cs
   • Importante: La extensión debe ser .cs (C Sharp)

Paso 2: Escribir el código

Copia exactamente este código en tu archivo:

using System;
using Eplan.EplApi.Base;
using Eplan.EplApi.ApplicationFramework;

public class HelloWorld
{
    [Start]
    public void Ejecutar()
    {
        MessageBox.Show("¡Hola! Este es mi primer script en EPLAN.",
                       "Mi Primer Script",
                       MessageBoxButtons.OK,
                       MessageBoxIcon.Information);
    }
}

Paso 3: Guardar

• Presiona Ctrl + S para guardar
• Verifica que el archivo se guardó como HelloWorld.cs en la carpeta correcta

Paso 4: Ejecutar desde EPLAN

Ahora viene la parte emocionante:

1. Abre EPLAN
2. No necesitas tener un proyecto abierto (este script funciona sin proyecto)
3. Ve a Fichero > Extras > Interfaces > Ejecutar script…
4. En el diálogo que aparece:
   • Busca y selecciona HelloWorld.cs
   • Clic en Ejecutar

¿Qué debería pasar?

Deberías ver un cuadro de diálogo con el mensaje:

"¡Hola! Este es mi primer script en EPLAN."

Si lo ves: ¡Felicidades! Acabas de ejecutar tu primer script.

Si no lo ves: Ve a la sección de “Problemas comunes” más abajo.

---

7. Entendiendo lo que acabas de hacer

Analicemos el script línea por línea:

using System;
using Eplan.EplApi.Base;
using Eplan.EplApi.ApplicationFramework;

Líneas 1-3: Importamos las librerías necesarias.

public class HelloWorld
{

Línea 5: Declaramos una clase llamada HelloWorld.

    [Start]
    public void Ejecutar()
    {

Líneas 7-8:

• [Start]: Marca este método como punto de entrada
• public void Ejecutar(): Define el método que se ejecutará

        MessageBox.Show("¡Hola! Este es mi primer script en EPLAN.",
                       "Mi Primer Script",
                       MessageBoxButtons.OK,
                       MessageBoxIcon.Information);

Líneas 10-13:

• MessageBox.Show(): Muestra un cuadro de diálogo
• Primer parámetro: El mensaje a mostrar
• Segundo parámetro: El título de la ventana
• Tercer parámetro: Qué botones mostrar (OK, Sí/No, etc.)
• Cuarto parámetro: Qué icono mostrar (Información, Error, Advertencia)

    }
}

Líneas 15-16: Cierran el método y la clase.

---

8. Mejorando tu primer script

Ahora que funciona, vamos a mejorarlo un poco. Modifica tu script para que se vea así:

using System;
using Eplan.EplApi.Base;
using Eplan.EplApi.ApplicationFramework;

public class HelloWorld
{
    [Start]
    public void Ejecutar()
    {
        // Obtener la fecha y hora actual
        DateTime ahora = DateTime.Now;
        string fechaHora = ahora.ToString("dd/MM/yyyy HH:mm:ss");

        // Obtener el nombre del usuario de Windows
        string usuario = Environment.UserName;

        // Construir el mensaje personalizado
        string mensaje = string.Format(
            "¡Hola {0}!\n\n" +
            "Este es tu primer script en EPLAN.\n" +
            "Fecha y hora: {1}\n\n" +
            "¡Bienvenido al mundo de la automatización!",
            usuario,
            fechaHora);

        // Mostrar el mensaje
        MessageBox.Show(mensaje,
                       "Mi Primer Script Mejorado",
                       MessageBoxButtons.OK,
                       MessageBoxIcon.Information);
    }
}

¿Qué hace este script mejorado?

1. Obtiene la fecha y hora actual
2. Obtiene tu nombre de usuario de Windows
3. Construye un mensaje personalizado con esa información
4. Lo muestra en un cuadro de diálogo

Ejecútalo nuevamente para ver la diferencia.

Nota: Los comentarios (líneas que empiezan con //) no se ejecutan. Son solo notas para los humanos.

---

9. Acceso rápido a scripts

Cada vez que quieras ejecutar un script, ir a Fichero > Extras > Interfaces > Ejecutar script… es tedioso. Veamos formas más rápidas:

9.1 Crear un menú personalizado

1. En EPLAN, haz click en la cinta.
2. Crea un grupo de comandos nuevo.
3. Busca Ejecutar scripts.

---

10. Problemas comunes

Problema 1: “El archivo no aparece en el diálogo”

Causa: No tiene la extensión correcta.

Solución:

1. Verifica que el archivo termina en .cs

Problema 2: “Error de compilación” o “Error de sintaxis”

Causa: Probablemente copiaste mal el código o falta un punto y coma.

Solución:

1. Verifica que copiaste exactamente el código del libro.
2. Presta atención a mayúsculas y minúsculas (C# es case-sensitive).
3. Verifica que no falten punto y coma ; al final de las líneas.
4. Los mensajes del sistema te ayudarán a identificar el problema.

---

Deep Dive: Namespaces de EPLAN disponibles

Para scripts simples, estos son los namespaces que usarás:

System: Funcionalidades básicas de C#

using System;                     // Básico
using System.IO;                  // Archivos y carpetas
using System.Text;                // Manipulación de texto
using System.Collections.Generic; // Listas y colecciones

EPLAN API: Funcionalidades de EPLAN

using Eplan.EplApi.Base;                    // Clases base
using Eplan.EplApi.ApplicationFramework;    // Aplicación
using Eplan.EplApi.Scripting;              // Scripts

Extras incluidos gratis:

using System.Windows.Forms;   // GUI (formularios, botones)
using System.Net.Http;        // Peticiones HTTP/REST
using Newtonsoft.Json;        // Manejo de JSON
using System.Xml.Linq;        // Manejo de XML

No necesitas memorizar esto ahora. Lo irás usando naturalmente en los próximos capítulos.

---

Mejores prácticas desde el inicio

Aunque apenas estás empezando, adopta estas buenas costumbres desde ahora:

1. Nombres descriptivos

// Mal
public class Script1 { }

// Bien
public class ExportarPDFMultiidioma { }

2. Comentarios útiles

// Mal (obvio)
// Mostrar mensaje
MessageBox.Show("Hola");

// Bien (explica el por qué)
// Informar al usuario que la exportación comenzó
MessageBox.Show("Exportación iniciada. Por favor espere...");

3. Organización de archivos

• Un script por archivo
• Nombre del archivo = Nombre de la clase
• Usa carpetas para categorizar

4. Backup regular

• Copia tus scripts a la carpeta Backup\ antes de hacer cambios grandes. También puedes hacer el uso de Git para el control de versiones.

---

Última actualización: Enero 2026