AugeLab Studio Manual
English
English
  • 👋Welcome to AugeLab Studio User Manual
  • 📘Introduction
    • AugeLab Studio
    • Key Features
    • Use Cases
    • System Requirements
  • 🚀Getting Started
    • Signing up
    • Installation
    • First Look
    • Simple Tour
    • Your Very First Project
      • Basics
      • Detection
      • Wrapping Up
    • More Local Examples
    • Further Reading
  • 🖥️AugeLab Studio Interface
    • Detailed Look
    • Scenario Area
    • Menu and Toolbar
    • Managing Projects
    • Installing AI and much more
      • Leverage AI with Module Downloader
  • 🧱Function Blocks
    • Block Structures
    • Sockets
    • Blocks Column
    • Connections
    • All Function Blocks
      • AI Blocks
        • Face Detection
        • Mask Detection
        • Object Detection - Custom
        • Object Detection
        • Pose Estimation
        • Safety Equipment Detection
        • Social Distance Detector
        • Super Resolution
        • Text Detection
        • OCR
      • CNN Blocks
        • Average Pooling 2D
        • Batch Normalization
        • Choose Folder 2D
        • Compile Model
        • Conv. Sep. Layer 2D
        • Conv. Trans. Layer 2D
        • Convolutional Layer 2D
        • Dropout Layer
        • Flatten Layer 2D
        • Fully Connected
        • Global Average Pooling 2D
        • Global Max Pooling 2D
        • Input Layer 2D
        • Loss CCE
        • Max Pooling 2D
        • Metrics Accuracy
        • Model EfficientNet
        • Model MobileNet
        • Model ResNet
        • Model VGG
        • Optimizer Adadelta
        • Optimizer Adagrad
        • Optimizer Adam
        • Optimizer Adamax
        • Optimizer FTRL
        • Optimizer Nadam
        • Optimizer RMSProp
        • Optimizer SGD
        • ReLU Layer
        • Softmax Layer
        • Training Parameters
      • Data/Logic
        • Flow Control
          • Batch Concatenation
          • Batch Processing
          • Debatch
          • Get Batch Size
          • HMI Background
          • Subsystem Enabled
          • Subsystem In
          • Subsystem Loop
          • Subsystem Out
          • Subsystem
        • logic
          • All True
          • And
          • Demux
          • Equals
          • Greater
          • Logic Operations
          • Mux
          • Not
          • Or
          • Set - Reset
          • Smaller
        • Mathmetical Operations
          • Add
          • Counter
          • Divide
          • Math Operations
          • Maximum
          • Minimum
          • Multiply
          • Not Equals
          • Round
          • Square Root
          • Subtract
          • Trigonometry
        • Data Operations
          • Data Memory
          • Data to JSON
          • Data Type Converter
          • Datetime Compare
          • Dictionary Operations
          • Exclude Nones
          • Find Substring
          • Get Element
          • Is None
          • List Operations
          • Parse Data Dictionary
          • Replace None
          • String Merge
          • String Operations
        • Referencing
          • Data Read Global
          • Data Read Local
          • Data Write Global
          • Data Write Local
          • Debug Input
          • Tag From
          • Tag To
        • Signal Operators
          • Delay Step
          • Edge Falling
          • Edge Rising
          • Multi Port Switch
          • OFF Delay
          • ON Delay
      • Image/Transformations
        • Analysis
          • Color Density Percentage
          • Get Dimension
          • Histogram On Curve
          • Histogram On Line
          • Image Color Match
          • Image Memory
          • Image Resolution and Channel Value
          • Maximum Images
          • Mean Value of Image
          • Measure Position Distance
          • Minimum Images
          • Non-zero of Image
          • Std. of Image
          • Structural Similarity
        • Transformation Filters
          • Auto Alignment
          • Auto Contrast
          • Color Quantizer and Clustering
          • Color Space
          • Contrast-Brightness-Gamma
          • Contrast Optimization
          • Deconvolution
          • Denoising
          • Distance Transformation
          • FloodFill
          • Grab Cut Algorithm
        • Color Filters
          • 2D Filter
          • Apply Mask
          • Bilateral Filter
          • Blur
          • Edge Filter
          • HSV Filter
          • Image Adaptive Threshold
          • Image Threshold
          • Invert Image
          • Morphological Transformations
          • Normalize Image
          • RGB Mask
          • RGB Set
          • Sobel Filter
        • Operations
          • Add Images Weighted
          • Add Images
          • Collage Images
          • Divide Images
          • Flip Image
          • Image AutoRotator
          • Image Concatenate
          • Image Resize
          • Image Resizer
          • Merge Channels
          • Multiply Images
          • Polar Transform
          • Rotate Image Angle
          • Slice Image
          • Split Image
          • Subtract Images
      • Detections/Shapes
        • Detectors
          • Barcode Reader
          • Blob Detector
          • Blur Detector
          • Circle Detector
          • Corner Detector
          • Custom CNN Model
          • Data Matrix Reader
          • Detect Reference
          • Feature Detector
          • Find Object - Multiple Image
          • Find Object
          • Find Reference
          • Harris Corner Filter
          • Line Detector
          • Match Shapes
          • Measure Object Distance
          • Shape Detector
        • Draw
          • Draw Detections
          • Draw Line
          • Draw Point
          • Draw Rectangle
          • Draw Result On Image
          • Write Date On Image
          • Write Text On Image
        • Roi Processing
          • Check Area (Polygon)
          • Check Area
          • Get Pixel Mouse
          • Get Pixel
          • Get ROI
          • Image ROI Center
          • Image ROI Polygon
          • Image ROI Select Multi
          • Image ROI Select
          • Image ROI
          • Perspective Transform
          • Rectangles in Rectangle
        • Shape Analysis
          • Approximate Contour
          • Choose Line
          • Contour to Image
          • Fill Contour
          • Find Contour
          • Hull Convex
          • Minimum Circle
          • Minimum Ellipse
          • Minimum Rectangle
          • Minimum Rotated Rectangle
          • Most Similar Shape
          • Point Polygon Test
      • Input/Output
        • Communication
          • Modbus Connect
          • Modbus Read
          • Modbus Write
          • MQTT Publish
          • MQTT Subscribe
          • OPC UA Client
          • OPC UA Read
          • OPC UA Write
          • REST API - Get
          • REST API - Post
          • Send Mail
          • Siemens S7 Connect
          • Siemens S7 Read
          • Siemens S7 Write
        • Data Inputs
          • Date-Time List
          • Date-Time
          • Headless Check
          • Keyboard/Barcode Reader
          • Logic Input
          • Number Input
          • Number Range
          • PWM (Pulse Width Modulation)
          • Rising Edge
          • String Input
          • Text
        • Image Inputs
          • Camera IP (ONVIF)
          • Camera IP
          • Camera USB External
          • Camera USB Vidgear
          • Camera USB
          • Load Image From Path
          • Load Image
          • Make Image
          • Pixel
          • Video
        • Outputs/Exports
          • CSV Export
          • Cycle Timer
          • File/Folder Operations
          • GPU Statistics
          • Image Logger
          • Image Write
          • Led Output
          • Multi Image Write
          • Output
          • Scope
          • Show Image
          • Stop
  • 📡Devices and Communication
    • Camera Usage
    • Communication Protocols
    • Further Reading
  • 🧩Example Projects
    • Demo Projects
    • Circumference Measurement
    • Object Counting
    • Tile Width Measurement
    • Human Detection
    • Object Detection
  • 🔑Key Features
    • Deploy Custom HMI Applications
    • Annotate Data for Object Detection
    • Train Custom AI Models
      • Choosing the Right Database
      • When to Stop Training
    • Create Plugins
      • Components
      • Coding Reference
    • Share Your Solutions with Community
    • Instal Python Packages
  • 📑FAQ
    • Contact Us
    • FAQ
    • Setting up a full project
  • Additional Resources
    • Training Schedule
    • Training Materials
    • AugeLab Experts
  • Appendix
    • Dictionary
    • References
Powered by GitBook
On this page
  • First Look
  • Block Configuration
  • **Parameter Settings Section**
  • **Generate Block Script Button**
  • **Code Editor**
  • Reloading Blocks into Designer Window

Was this helpful?

  1. Key Features

Create Plugins

Develop custom nodes using the power of Python.

PreviousWhen to Stop TrainingNextComponents

Last updated 8 months ago

Was this helpful?

First Look

Designer Window allows you to create and integrate your own custom blocks by utilizing the power of Python and its community. The figure below shows how an empty designer window looks like.

The Block Configuration section enables users to set up the basic properties of the custom block they are creating.

Block Configuration

Block Name

The "Block Name" field allows users to specify a name for their custom block. It is important to avoid using spaces or special characters in the block name.

Block Width & Height

The "Block Width" and "Block Height" fields enable users to define the size of their custom block. These values determine the dimensions of the block in the workspace.

Load, Save, and Reset Configuration Buttons

The "Load Block Configuration," "Save Block Configuration," and "Reset Block Configuration" buttons provide options to manage the block configurations efficiently. Users can load a previously saved configuration, save the current configuration for future use, and reset the block configuration to default settings if needed.

**Parameter Settings Section**

The Parameter Settings section allows users to define the input and output sockets of the custom block they are creating. Additionally, users can add and remove components within the block.

Input Socket List

The "Input Socket List" displays the currently defined input sockets for the custom block. Users can drag and drop the sockets to rearrange their order. To add a new input socket, click the "+" button, and to remove an existing input socket, click the "-" button.

Each input socket in the list has the following properties:

  • Name: Users can enter a unique name for each input socket.

  • Type: The type of the input socket, such as Image, Integer, Number, Boolean, String, and Generic.

Output Socket List

The "Output Socket List" displays the currently defined output sockets for the custom block. Users can add/subtract sockets to rearrange their order and count. To add a new output socket, click the "+" button, and to remove an existing output socket, click the "-" button.

Each output socket in the list has the following properties:

  • Name: Users can enter a unique name for each output socket.

  • Type: The type of the output socket, such as Image, Integer, Number, Boolean, String, and Generic.

Component List

The "Component List" displays the components currently added within the custom block. Users can drag and drop the components to rearrange their order. To add a new component, click the "+" button, and to remove an existing component, click the "-" button.

Each component in the list has the following properties:

  • Name: Users can enter a unique name for each component.

  • Type: The type of the component, such as TextInput, DropDown, Label Slider, SliderLabeled CheckBox, Button, Image, Table

**Generate Block Script Button**

The "GENERATE BLOCK SCRIPT" button creates a Python script that represents the custom block configuration. After configuring all the settings and defining the input/output sockets and components, users can click this button to generate the Python script for their custom block.

The generated script can then be saved and integrated into AugeLab Studio for use within the node editor.

Note: Ensure that all settings and configurations are properly defined before generating the block script.

**Code Editor**

The code editor area provides a text editor where users can view and edit the generated Python script for their custom block. The script is automatically updated when users change the block's configurations in the Designer Window. The code editor enables users to refine and customize the generated script as needed.

The code editor section uses _tab_s as indentation

Reloading Blocks into Designer Window

In order to reload a custom block, right-click on custom block name in Blocks section and click on "Load into Designer Window".

🔑