Урок 1 — введение в разработку расширений

Цели

  • Создать простое работающее расширение на C#;
  • Рассмотреть общий порядок разработки; подробности будут разобраны в следующих уроках.

Практическая часть

Порядок действий:

  • Откройте репозиторий GitVerse и клонируйте его.
  • Найдите каталог ExtensionEmptyNet — он послужит основой нового расширения.
  • Проверьте ExtensionEmptyNet/.stbuild/build/stbuild.csproj: в нём указана версия системы сборки. Для доступа к новым возможностям системы сборки может потребоваться её обновление.
  • Откройте проект ExtensionEmptyNet/project/main/ExtensionEmptyNet.csproj. Его структура и особенности будут рассмотрены в следующих уроках. Сейчас задача — создать простейшее расширение.
  • Проверьте версию пакета SprutTechnology.CAMAPI.SDK.Net: для доступа к новым возможностям API может потребоваться её обновление.
  • При необходимости измените ExtensionTest.cs. Вы можете использовать API без ограничений; пример упрощён, чтобы показать общий процесс создания расширения.
  • Для выполнения кода DLL должна содержать класс ExtensionFactory. CAM-система вызовет его метод Create, получит экземпляр класса расширения и выполнит его код.
  • Измените JSON-файл:
    • Тип расширения должен совпадать с идентификатором entry point;
    • Идентификатор расширения должен соответствовать значению, которое ожидает метод ExtensionFactory.Create;
{
    "name": "Empty extension on C#",
    "description": "Empty extension on C#",
    "module_path": "${extensionJsonFolder}/ExtensionEmptyNet.dll",
    "extensions": [
        {
            "utility": {
            "name": "Empty extension on C#",
                "caption": "Empty extension on C#",
                "id": "Extension.Utility.Empty.Net"
            }
        }
    ]
}
  • Соберите проект, чтобы проверить его работоспособность.
  • Создайте файл установки расширения с помощью команды ExtensionEmptyNet/commands/pack.cmd;
  • При успешной упаковке появится файл ExtensionEmptyNet/project/main/bin/ExtensionEmptyNet.dext. Его можно установить на этом или другом компьютере с соответствующей версией CAM-системы.
  • Дважды щёлкните файл, чтобы установить расширение.
  • Запустите CAM-систему, откройте меню утилит и выберите Empty extension on C#. Название пункта должно соответствовать значению caption в JSON.
  • Убедитесь, что открылся Блокнот со сведениями о проекте.