Logo

Contents

  • EVA ICS v4
    • System documentation
      • Quick start
        • Few words from the authors
        • Installation
        • The task
        • Commons
        • Connecting the equipment
          • Creating items
          • Fieldbus connection
        • Defining logic
          • Rules
          • Logic macros
        • Building Human-Machine Interface
          • Creating users and ACLs
          • Creating a web-HMI application
        • The same but with deployment
      • Installation
        • Supported operating systems
          • Recommended for production setups
          • Tested and fully compatible
        • Preparing the system
        • Installing
          • Basic install
          • Installer arguments
        • Post-install configuration
        • Startup
        • Configuring/rebuilding Python venv
        • Updating
          • Local nodes
          • Remote nodes
        • Running under a restricted user
      • Node replication
        • Single-level clusters
          • Setting up a primary node
          • Setting up a secondary node
          • Connecting nodes
        • Multi-level clusters
          • Setting up a top node
          • Setting up the middle node
          • Connecting nodes
      • Migration to V4
        • Why migrate to EVA ICS v4
        • Migration
          • V3 nodes in V4 cluster
          • V3 and V4 nodes on the same machine
          • Logic
          • Item states
          • AAA
          • Python macros
          • Deployment
          • Item scripts
          • UDP API
      • What is new
        • 4.0.2-stable
        • 4.0.1-stable
        • 4.0.0-stable
        • 4.0.0 (2022-10-05)
          • Common
      • Platform architecture
        • Basics
        • Service types
          • Common types
          • Service names
        • Primary external services
        • Additional external services
        • Service management
          • Create
          • Manage
          • Destroy / undeploy / purge
          • Advanced configuration
      • Local clustering and secondary points
        • Basics
        • Architecture
        • Configuration
        • Moving services to secondary points
        • Updating
        • Uploading files via deployment
      • Configuration
        • Configuration files
          • eva_config
          • watchdog
        • Configuration registry keys
          • eva/config/core
          • eva/config/bus
          • eva/config/registry
          • eva/config/logs
          • eva/config/python-venv
        • Troubleshooting
      • Registry database
        • Technology
        • Reasons
        • Maintenance
          • Bus cheat-sheet
        • Structure
      • Authentication, authorization and accounting
        • Basics
        • Structure
          • Access control list
          • API key
          • User
          • Session token
      • Items
        • Item types
          • sensor
          • unit
          • lvar
          • lmacro
        • Creating and managing items
        • Item states
        • Common item properties
          • OID
          • meta
          • enabled
          • logic
          • connected
          • node
      • Command-line tools
        • eva-shell
          • Installing/updating
        • EVA Cloud Manager CLI
        • Bus CLI
        • Registry management
          • Command-line tools
        • Python VENV management
      • IaC and deployment
        • Deployment file
          • AAA
          • Uploading files
          • Items
          • Macros
          • Services
          • Generator sources
          • Extra commands
        • Deployment via CLI
          • Deploying
          • Undeploying
        • Node parameters
        • Advanced configuration
        • Dealing with timeouts
          • General timeout
          • Remote node timeout
          • Downloading files on remote nodes
      • Running in containers
        • The official images
          • What is included
          • Volumes
          • Preparation
          • Configuring the node core
          • Initialization
          • Deployment
          • Updating
        • Features of using with Kubernetes
      • Using with Kubernetes
        • Basics
        • Native vs mixed
        • Configuring containers
        • Conclusion
      • High-load environments
        • Tuning EVA ICS
        • Hardware
      • Understanding timeouts
        • Call timeouts
        • The schema
        • Configuring the timeouts
          • Client timeout
          • Local replication pub/sub timeout
          • Individual remote node timeouts
          • Bus call timeout
      • Troubleshooting
        • Creating dumps
          • Plain
          • Encrypted
        • Support requests
        • Community support
      • Security
        • Functionality
        • Native packages
          • Supported distributions
          • OpenSSL versions
          • Switching to native
        • Universal packages
          • OpenSSL versions
        • FIPS 140
        • Connecting untrusted remote nodes
    • The core and services
      • The core
        • Configuration
        • EAPI methods
          • action
          • action.kill
          • action.list
          • action.result
          • action.terminate
          • action.toggle
          • bus.publish
          • core.shutdown
          • core.sysinfo
          • item.announce
          • item.create
          • item.deploy
          • item.destroy
          • item.disable
          • item.enable
          • item.get_config
          • item.list
          • item.state
          • item.summary
          • item.undeploy
          • log.get
          • log.purge
          • lvar.clear
          • lvar.decr
          • lvar.incr
          • lvar.reset
          • lvar.set
          • lvar.toggle
          • node.get
          • node.list
          • run
          • save
          • spoint.list
          • svc.deploy
          • svc.get
          • svc.get_params
          • svc.list
          • svc.purge
          • svc.restart
          • svc.undeploy
          • test
          • update
      • 1-Wire (OWFS) controller
        • Setup
        • EAPI methods
          • action
          • kill
          • terminate
          • w1.get
          • w1.info
          • w1.scan
          • w1.set
      • Active directory auth service
        • Setup
        • EAPI methods
          • auth.user
          • cache.delete
          • cache.purge
        • Preparing related services
        • Active Directory configuration
        • Usage
          • Authentication
          • ACL prefixes
      • Bus UDP bridge
        • Outgoing payload
        • Incoming payload
        • Installing/updating
        • Setup
        • EAPI methods
      • Data generator
        • Usage
          • Item targets
          • RPC targets
          • Sampling
          • Planning
          • Applying
        • Generator sources
          • Counter
          • Random
          • Random float
          • UDP float
          • Wave
        • Setup
        • EAPI methods
          • source.apply
          • source.deploy
          • source.destroy
          • source.get_config
          • source.list
          • source.plan
          • source.undeploy
      • Default ACL service
        • Setup
        • EAPI methods
          • acl.deploy
          • acl.destroy
          • acl.export
          • acl.format
          • acl.get_config
          • acl.list
          • acl.undeploy
      • Docker Application launcher
        • Requirements
        • Networking
        • Volumes
        • Applications
        • Deployment example
          • deploy.yml
          • docker-compose.yml
          • nginx.conf
        • Setup
        • EAPI methods
          • app.get_config
      • Ethernet/IP PLC controller gateway
        • Setup
        • EAPI methods
          • action
          • kill
          • terminate
          • var.get
          • var.set
      • File manager service
        • Setup
        • EAPI methods
          • file.get
          • file.put
          • file.unlink
          • sh
      • HMI kiosk manager
        • Creating/managing kiosks
          • Creating a kiosk connection
          • Using one-time accounts for authentication
          • Listing kiosk states
          • Destroying kiosk connection
          • More functions
          • Kiosks and IaC-deployment
        • Setup
        • EAPI methods
          • kiosk.alert
          • kiosk.deploy
          • kiosk.destroy
          • kiosk.dev_close
          • kiosk.dev_open
          • kiosk.display
          • kiosk.eval
          • kiosk.get_config
          • kiosk.info
          • kiosk.list
          • kiosk.login
          • kiosk.logout
          • kiosk.navigate
          • kiosk.reboot
          • kiosk.reload
          • kiosk.test
          • kiosk.undeploy
          • kiosk.zoom
      • HMI service
        • Setup
        • EAPI methods
          • api_log.get
          • authenticate
          • i18n.cache_purge
          • session.broadcast.reload
          • session.broadcast.restart
          • session.destroy
          • session.list
          • tpl.reload
          • ws.stats
        • HTTP API
          • Basics
          • action
          • action.kill
          • action.result
          • action.terminate
          • action.toggle
          • api_log.get
          • bus::<TARGET_SVC>::<METHOD>
          • call
          • item.check_access
          • item.state
          • item.state_history
          • item.state_log
          • log.get
          • login
          • logout
          • lvar.clear
          • lvar.decr
          • lvar.incr
          • lvar.reset
          • lvar.set
          • lvar.toggle
          • run
          • session.list_neighbors
          • session.set_readonly
          • set_password
          • test
          • x::<TARGET_SVC>::<METHOD>
        • Web socket methods
          • bye
          • ping
          • subscribe.log
          • subscribe.state
          • subscribe.state_initial
          • unsubscribe.state
          • Events
      • InfluxDB state history
        • Setup
        • EAPI methods
          • state_history
          • state_log
          • state_push
        • Retention policies
      • Item state expiration service
        • Setup
      • Item state file writer (JSON/CSV)
        • Setup
        • EAPI methods
          • flush
          • rotate
      • Legacy (V3) replication service
        • Limitations
          • Protocol and configuration
          • Items
          • rpvt
        • Installing/updating
        • Setup
        • EAPI methods
          • node.list
          • node.reload
      • Local user/key authentication service
        • Setup
        • EAPI methods
          • auth.key
          • auth.user
          • key.deploy
          • key.destroy
          • key.export
          • key.get
          • key.get_config
          • key.list
          • key.regenerate
          • key.undeploy
          • password.hash
          • user.create_one_time
          • user.deploy
          • user.destroy
          • user.export
          • user.get_config
          • user.list
          • user.set_password
          • user.undeploy
      • Logic manager
        • Functionality
          • Rules
          • Cycles
          • Jobs
        • Setup
        • EAPI methods
          • action
          • cycle.get
          • cycle.list
          • cycle.reset
          • cycle.start
          • cycle.stop
          • job.get
          • job.list
          • kill
          • rule.get
          • rule.list
          • terminate
      • Mailer service
        • Setup
        • EAPI methods
          • send
      • Mirror service
        • Updating mirror files on the source node
        • Configuring mirror on target nodes
        • Setup
      • Modbus master controller
        • Setup
        • EAPI methods
          • action
          • kill
          • reg.get
          • reg.set
          • terminate
      • Modbus slave service
        • Setup
        • EAPI methods
          • MB
          • save
      • OPC-UA controller gateway
        • Setup
        • EAPI methods
          • action
          • kill
          • terminate
          • var.get
          • var.set
          • var.set_bulk
      • OTP 2nd-Factor authentication service
        • Setup
        • EAPI methods
          • otp.check
          • otp.destroy
      • Python macros controller
        • Installing/updating
        • Setup
        • EAPI methods
          • run
      • Replication service
        • Pub/sub security
        • Replicating untrusted nodes
        • Setup
        • EAPI methods
          • bus::<SVC_ID>::<METHOD>
          • node.append
          • node.deploy
          • node.export
          • node.get
          • node.get_config
          • node.list
          • node.mtest
          • node.reload
          • node.remove
          • node.test
          • node.undeploy
      • SNMP/UDP trap handler
        • SNMP Traps
          • Processing
          • Supported SNMP data types
        • Native traps
          • Updates
          • Actions
          • Encrypted/compressed traps
        • Setup
      • SQL databases state history
        • Setup
        • EAPI methods
          • state_history
          • state_log
          • state_push
      • Script runner controller
        • Commons
        • Update scripts
        • Action scripts
          • Current unit states
        • Setup
        • EAPI methods
          • action
          • kill
          • terminate
          • update
      • Shared lock service
        • Setup
        • EAPI methods
          • list
          • lock
          • status
          • unlock
      • Text-to-speech service
        • Installing/updating
        • Setup
        • EAPI methods
          • say
      • TwinCAT ADS bridge
        • Setup
        • EAPI methods
          • ping
          • read
          • su_read
          • su_write
          • su_write_read
          • write
          • write_read
      • TwinCAT ADS controller
        • Setup
        • EAPI methods
          • action
          • kill
          • terminate
          • var.get
          • var.set
          • var.set_bulk
      • Virtual controller
        • Setup
        • EAPI methods
          • action
          • get
          • list
          • set
          • var.destroy
          • var.get
          • var.list
          • var.set
          • var.set_bulk
        • Controller modes
          • Simple
          • PLC simulation
      • Zero-failure replication service
        • Service roles
          • Collector
          • Replicator
          • Standalone
        • Recommendations
        • Untrusted nodes and zero-failure replication
        • Setup
        • EAPI methods
          • client.start
          • disable
          • enable
          • mailbox.delete_block
          • mailbox.fill
          • mailbox.get_block
          • mailbox.list_blocks
          • mailbox.rotate
          • process_dir
          • status
    • Cloud Manager UI
      • Installation
        • Windows 10/11+
        • Linux (Ubuntu 20.04/22.04)
        • Other operating systems
      • Operating manual
        • Connecting to a node
          • Connection dialog
          • Connection path
          • Timeout
        • Common operations
          • Monitoring tables
          • Adding a resource/item
          • Editing resources/items
          • Deleting resources/items
          • Exporting resources/items
          • Importing resources/items
        • Actions
          • Watching an action
        • Broker
        • Items
          • Displaying items
          • Unit actions
          • Running lmacros
          • Lvar operations
          • Watching item states
        • Log
        • Services
          • Service management
          • Service info and EAPI methods
        • Secondary points
    • EVA ICS Enterprise
      • General terms and conditions
      • Enterprise services
        • Installation
        • Active Directory authentication
        • Zero-failure replication
        • HMI Kiosk manager
      • EVA ICS WebEngine WASM extension
        • Installation
        • Licensing
        • Limitations
      • PSRT Enterprise
      • Mission-critical projects
    • Interface development (HMI apps)
      • UI development
        • Basics
        • Web applications
        • Authentication
        • The model
        • Handling file uploads
      • Serving private data (PVT)
        • Loading files from PVT Server
        • Serving private data from EVA ICS Registry
        • Serving remote resources (RPVT)
          • Local network resources
          • Remote network resources
      • Serving structured data
        • Format conversion
        • Multi-language
          • Usage
          • Generating
          • Locale cache
        • Serving structured data from EVA ICS Registry
      • HMI file uploads
        • File upload form
          • How does it work
          • Errors
          • Additional form parameters
        • Processing macro
        • Security and file upload limits
      • Server Templates
        • Working with server templates
        • Template files
        • Template variables
      • Front-end server for HMI service
        • Example with NGINX
      • Mobile clients
        • Android
          • EVA ICS Control Center client
          • Building own client
          • Authentication
        • Apple iOS and other mobile platforms
      • Two-factor OTP authentication
        • System setup
          • Services
          • Excluding user accounts from OTP
          • Resetting OTP for a user account
        • User authentication
          • API
          • Authenticator programs
        • HMI application example
    • Automation
      • Inverted states
        • Pulling data
        • Actions
      • Logic manager
        • Functionality
          • Rules
          • Cycles
          • Jobs
        • Setup
        • EAPI methods
          • action
          • cycle.get
          • cycle.list
          • cycle.reset
          • cycle.start
          • cycle.stop
          • job.get
          • job.list
          • kill
          • rule.get
          • rule.list
          • terminate
      • Opener robots
        • Hardware schemas
          • AC circuit
          • RDC circuit
        • Software configuration
      • Python Logic Macros
        • Executing macros
        • Common principles of macros operation
        • System macros
          • On startup
          • On shutdown
        • Macros and security
        • Macros built-ins
        • Built-in exceptions
        • Variables
        • Built-in functions
        • General functions
          • date - date/time
          • decrement_shared - decrements value of the shared variable
          • exit - finishes macro execution
          • get_directory - gets path to EVA ICS directory
          • increment_shared - increments value of the shared variable
          • instant - system monotonic timer value
          • ls - lists files in directory
          • mail - sends email message
          • ping - pings a remote host
          • rpc_call - performs a bus RPC call
          • run - executes another lmacro
          • service - get the service object for the direct access
          • set_shared - sets value of the shared variable
          • sha256sum - calculates SHA256 sum
          • shared - gets value of the shared variable
          • sleep - sleep(seconds)
          • system - execute the command in a subshell
          • system_name - get the system name
          • time - current time in seconds since Epoch
        • Item functions
          • state - gets item state
          • status - gets item status
          • value - gets item value
        • LVar functions
          • clear - clears lvar status
          • decrement - decrements lvar value
          • increment - increments lvar value
          • is_expired - checks is lvar (timer) or item state expired/error
          • reset - resets lvar status
          • set - sets lvar value
          • toggle - toggles lvar status
        • Unit control
          • action - executes unit control action
          • action_toggle - executes an action to toggle unit status
          • is_busy - checks is the unit busy
          • kill - kills unit actions
          • result - gets action status
          • start - executes an action to a unit
          • stop - executes an action to stop a unit
          • terminate - terminates action execution
        • Locking functions
          • lock - acquires a lock
          • unlock - releases a lock
        • Logging
          • debug - log debug message
          • info - log info message
          • warning - log warning message
          • error - log error message
          • critical - log critical message
      • Node-RED integration
        • EVA ICS Setup
          • docker-compose.yml
          • deploy.yml
          • UDP bridge
        • Node-RED setup
          • UDP input
          • UDP output
    • Software Development Kit (SDK)
      • Rust SDK
        • Rust bindings and libraries
        • A simple service in Rust
          • The task
          • Creating a project
          • Preparing the system
          • Service code
          • Service template
        • Extending HMI with X calls in Rust
          • X call basics
          • Service example
          • Service template
          • API call example
        • Keeping service data between reloads
          • Keeping data in the node registry
          • Keeping data in files
        • API reference (commons)
        • API reference (SDK)
        • External BUS/RT services
          • The task
          • Preparation
          • Source code
          • Registering the service in Windows
          • Calling RPC methods
      • Python SDK
        • Python bindings and libraries
        • A simple service in Python
          • SDK Installation
          • The task
          • Preparing the system
          • Service code
          • Service template
        • Extending HMI with X calls in Python
          • X call basics
          • Service example
          • Service template
          • API call example
        • Keeping service data between reloads
          • Keeping data in the node registry
          • Keeping data in files
        • API reference
          • SDK
          • HTTP Client
      • EAPI commons
        • Calling EAPI methods
          • Type specifications
          • Error codes
        • EAPI Basics
          • Metadata format
          • Method info structure
          • Example
        • Communications
          • The core
          • ACL services
          • Core events
          • Raw events
          • Replication events
          • Actions
          • Logs
          • Auth
          • Service topics
        • Security model and call ACLs
        • Initial payload
        • Controller service requirements
          • Events
          • Unit actions
          • Macros actions
      • Pub/Sub RPC and data replication
        • Common
        • Events
        • Tests
        • Announce/discovery/node state
        • Bulk events
        • RPC
          • Requests
          • Replies
          • Encryption
    • Fieldbus protocols and equipment
    • License
      • TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        • 1. Definitions.
        • 2. Grant of Copyright License.
        • 3. Grant of Patent License.
        • 4. Redistribution.
        • 5. Submission of Contributions.
        • 6. Trademarks.
        • 7. Disclaimer of Warranty.
        • 8. Limitation of Liability.
        • 9. Accepting Warranty or Additional Liability.
      • Common Clause 1
  • EVA ICS Machine Learning kit
    • Machine Learning kit server
      • Installation
        • Downloading/updating
        • Installing server license key
        • Creating/deploying service instances
        • Using front-end web server
      • Data processing best practices
        • Querying data
          • Apache arrow streams
          • CSV streams
        • Uploading data
          • Apache arrow streams
          • Apache arrow files
          • CSV files/streams
      • HTTP API
        • Query item state history
          • OID processing map
        • Upload item state history
          • OID upload processing map
      • EAPI
        • Methods
          • Citem.state_history
          • N
          • NB
        • Payloads
          • OID processing map
    • Python client
      • Installation
        • Workstation/standalone
        • EVA ICS venv
      • Querying data
        • HTTP Lazy initialization
        • BUS/RT Lazy initialization
        • Standard initialization
        • OID mapping
        • OID mapping from CSV file
        • Usage example
      • Uploading data
      • Module API
    • R client
      • Installation
        • With remotes/devtools
        • Manual
      • Querying data
      • Uploading data
      • Module API
        • eva.session
          • Description
          • Usage
          • Arguments
        • eva.authenticate
          • Description
          • Usage
          • Arguments
        • eva.call
          • Description
          • Usage
          • Arguments
        • eva.credentials
          • Description
          • Usage
          • Arguments
        • eva.test
          • Description
          • Usage
          • Arguments
        • eva.history.request
          • Description
          • Usage
          • Arguments
        • eva.history.append_oid
          • Description
          • Usage
          • Arguments
        • eva.history.fetch
          • Description
          • Usage
          • Arguments
        • eva.history.push
          • Description
          • Usage
          • Arguments
    • Machine learning: regressions
      • System preparation
        • Install Python modules
        • Create OID mapping
      • Training the model
        • Testing data fetch
        • Perform the training
      • Predicting events
        • Fetching data
        • Performing a prediction
  • EVA ICS WebEngine
    • Quick start
      • Initialization
      • Configuration
      • Watching states and performing API calls
    • Migration from EVA ICS JS Framework
    • Types exported
    • Configuring
      • API and Authentication
      • Item processing, special
      • Read-only informational variables
      • Loading configuration
    • Calling API methods
      • Single API calls
      • Bulk API calls
      • Error codes
    • Worker intervals
    • Handling engine events
    • QR code for evaHI-based apps
    • Advanced usage
      • Multi-page interfaces, external authentication
        • The primary page
        • Secondary pages
      • Authentication with front-end server
    • API reference
      • WebEngine
  • EVA ICS WebEngine React
    • Commons
      • Default web engine
      • Creating a new project
    • UI Components
      • HMIApp
        • Example
        • Parameters
        • Types
          • FunctionLogout
        • Interfaces
          • LoginProps
        • CSS classes
      • ItemValue
        • Example
        • Parameters
        • Interfaces
          • ItemValueThreshold
        • CSS classes
      • ItemValueTable
        • Example
        • Parameters
        • Interfaces
          • ItemValueDisplay
          • ItemValueThreshold
        • CSS classes
      • ControlButtonToggle
        • Example
        • Parameters
        • CSS classes
        • CSS Example
      • ControlButtonValue
        • Example
        • Parameters
        • CSS classes
      • ControlButtonRun
        • Example
        • Parameters
        • CSS classes
      • ControlBlock
        • Example
        • Parameters
        • Types
          • ControlButtonKind
        • Interfaces
          • ControlButtonDisplay
        • CSS classes
      • Gauge
        • Example
        • Parameters
        • Types
          • GaugeType
          • GaugeStrokeLineCap
        • CSS classes
      • LineChart
        • Example
        • Preparing
        • Parameters
        • CSS classes
      • Canvas
        • Example
        • Parameters
        • Interfaces
          • CanvasPosition
          • ControlButtonDisplay
          • ItemValueDisplay
        • CSS classes
    • Low-level hooks
      • useEvaState
        • Parameters
        • Usage example
      • useEvaStateHistory
        • Parameters
        • Output
        • Usage example
      • useEvaAPICall
        • Parameters
        • Output
        • Usage example
  • EVA ICS Application for Grafana
    • Installation
      • Via Grafana catalog
      • Manual
    • Connecting
      • Creating Grafana data source
      • Configuring
        • EVA ICS API keys
        • Grafana data source
    • Querying data
      • Basics
      • Example queries
        • Current item state
        • State history
        • System monitoring
      • Advanced
        • Calling methods on remote nodes
    • Controls
      • Installing
      • Configuring in Grafana
      • Using custom embedded HMI applications
  • rPLC
    • Quick start
      • The task
      • Creating a new Rust project
      • Creating PLC configuration
      • Building PLC context and I/O
      • Creating our first PLC program
      • Program threads
      • Going real-time
      • More samples
    • Basics
      • Function “main”
      • PLC status
      • Stack size
      • Shutdown
        • Timeout
        • Custom shutdown function
      • Building PLC context and I/O
      • Control files
      • Error handling
    • PLC context
      • Defining
        • Data types
        • Arrays
        • Structures
        • Arrays of structures
        • Boxed arrays
        • Custom types
      • Accessing
        • With macros
        • Directly
      • Serialization
    • PLC programs
      • Defining
      • Shifting
      • Spawning
      • Thread names
    • Logging
      • Logging messages
      • Logging stats
      • Verbose logging
      • Syslog logging
    • Custom building
      • Config variables
      • Assigning the variables
    • Real-time threads
      • Intro
      • CPU isolation
      • Thread affinity and priority
    • Input/output
      • Modbus master (client) I/O
        • Block configuration
        • Register codes
        • Input blocks
        • Output blocks
        • IEEE-754 endianness
      • Modbus slave (server) I/O
        • Defining Modbus servers
        • Defining Modbus context
        • Program example
      • OPC-UA client I/O
        • Block configuration
        • Input blocks
        • Output blocks
      • EVA ICS v4 EAPI
        • Action pool size
        • Block configuration
        • Input blocks
        • Output blocks
        • Real-time
        • Connecting to EVA ICS node
        • Accessing PLC instance from EVA ICS
          • Basics
          • Unit actions
          • API calls
      • Custom I/O
        • plc.yml
        • main.rs
        • Cargo.toml
        • build.rs
    • Internal API
      • API protocol
      • API methods
    • Managing PLC instances
      • PLC var directory
      • Registering a PLC instance
      • Unregistering PLC instance
      • Additional commands
  • Virtual Fieldbus Simulator
    • Installation
      • Preparing the system
      • Downloading/updating
    • Modbus
      • Virtual Modbus port
        • Deployment
        • EAPI
      • Virtual Modbus generic context
        • Features provided
        • Deployment
        • EAPI methods
          • save
      • Virtual Modbus sensor
        • Features provided
        • Deployment
        • EAPI methods
          • var.get
          • var.set
      • Virtual Modbus relay
        • Features provided
        • Deployment
        • EAPI methods
          • var.get
    • TwinCAT/ADS
      • Virtual ADS port
        • Deployment
        • EAPI methods
          • list
      • Virtual ADS service
        • Features provided
        • Deployment
        • EAPI methods
          • handle.list
          • state.get
          • state.set
          • var.get
          • var.list
          • var.set
      • Supported features and limitations
    • Data generators
    • What is new
  • PSRT - industrial Pub/Sub for WAN
    • PSRT server and clients
      • Source code
      • Installation (free version)
        • Building from source
        • Configuration files
        • Troubleshooting
        • Authentication
      • Statistical data
        • Overview (web interface / API)
        • Most active topics
      • UDP encryption
      • Enterprise version
    • PSRT clusters
      • Cluster nodes
      • Node configuration
      • Usage
    • PSRT protocol specifications
      • Common
      • Control socket
        • Greetings
        • Subscribe
        • Unsubscribe
        • Publish
        • Publish if subscribed (replicate)
        • Bye
      • Data socket
        • Greetings
        • Keep-alive pings
        • Message push
        • Bye
      • UDP
        • Plain
        • Encrypted
    • Security
      • Functionality
      • Native packages
        • Supported distributions
        • OpenSSL versions
      • Universal packages
        • OpenSSL versions
      • FIPS 140
  • BUS/RT - IPC bus
    • IPC documentation
      • Bindings
      • Inter-process communication
        • Client registration
        • Broadcasts
        • Topics
        • QoS
      • Security and reliability model
      • Rust crate features
      • Performance tips
    • Broker
      • Broker API
      • Stand-alone broker server
      • Embedded broker
        • Security model
    • Protocol specifications
      • Greetings
      • Outgoing frames
      • Pings (keep-alive frames)
      • Incoming frames
        • Acknowledgements
        • Messages
        • Topic publications
    • RPC layer specifications
      • Payload bytes
        • Requests
        • Responses
        • Error codes
    • RPC Cursors
      • When to use cursors
      • Technical background
      • Server example
      • Client example
    • Secondary clients and blocking RPC
      • Event handlers and RPC
        • The problem
        • Solutions
      • Secondary clients
        • Creating secondary clients in Rust
          • Internal
          • IPC
          • Handling frames
        • Creating secondary clients in other languages
  • Commons
    • Sharing terminal sessions
      • Setup
        • Automatic
        • Manual
      • Usage
      • Security
      • Issues
  • Legacy products
    • EVA ICS v3
      • System Documentation
        • Installation
          • Officially supported platforms
          • System Requirements
          • Using installer
          • Manual installation
          • Updating
          • Moving to another folder
          • Setting up additional features
          • Watchdog
          • How to assign IDs to items
          • Cloud setup
          • Log file customization
          • Using NGINX as a frontend for SFA interface
          • Serving local mirror
        • What's new
          • 3.4.2 (2021-12-20)
          • 3.4.1 (2021-09-06)
          • 3.4.0 (2021-07-07)
          • 3.3.2 (2021-03-01)
          • 3.3.1 (2020-08-26)
          • 3.3.0 (2020-02-05)
          • 3.2.5 (2019-10-03)
          • 3.2.4 (2019-07-30)
          • 3.2.3 (2019-06-24)
          • 3.2.2 (2019-05-21)
          • 3.2.1 (2019-04-16)
          • 3.2.0 (2019-04-02)
          • 3.1.1 (2018-10-22)
          • 3.1.0 (2018-09-01)
          • 3.0.2 (2018-06-23)
          • 3.0.1 (2018-02-21)
          • 3.0.0 (2017-10-19)
        • Quick start
          • Installation
          • Task
          • Connecting the equipment
          • Defining logic
          • Building a very simple Human-Machine Interface
        • Security
          • General recommendations
          • Network design
          • Should I run it as root?
          • API recommendations
        • Registry database
          • Technology
          • Reasons
          • Configuration
          • Maintenance
          • Structure
          • SDK
        • Notification system
          • Event structure
          • Configuring the notification endpoints
          • MQTT (mqtt)
          • PSRT
          • UDP notifiers (LURP)
          • DB Notifiers
          • 3rd party Clouds
          • File notifiers
          • HTTP Notifiers
          • Bulk (buffered) notifications
          • Notifier frame counters
          • Switching Pub/sub notifiers
        • Data pullers
          • Configuration
          • Execution
          • Data exchange
          • Pulr
        • Command line interfaces
          • EVA command line apps
          • Device control apps
        • Authentication
          • API keys
          • Users
          • Combined ACLs
        • IaC and deployment
          • Deployment configuration file
          • How to deploy configuration
        • FAQ
          • Is this a “smart home”?
          • Is this IoT?
          • If the system is free and open, what is your interest?
          • Is EVA ICS complicated and difficult to learn?
          • Is it reliable?
          • How about security?
          • What programming languages can I use to write scripts and macros?
          • What if I have zero experience in programming?
          • What automation is all about? What are automation components?
          • Is EVA ICS IEC 61131-3 compliant?
          • Where is the interface? I want a web interface!
          • Why EVA ICS has 3 different APIs?
        • High-load environments
          • Tuning EVA ICS
          • Hardware
          • Benchmarks
        • Crash-free setup
          • Inventory configuration
          • Users and API keys
          • Item states
          • Logs
          • Suicide timeouts
        • Always exec
        • EVA ICS container
          • Permanent volumes
          • Configuration variables
          • Prepare / setup scripts
          • Updating
        • Enterprise extensions
          • EVA JS Framework WASM extension
          • PSRT Enterprise
      • Components
        • Universal Controller
          • UC POLL DELAY
          • config/uc/main registry key
          • Custom variables
          • Action queues
          • Startup and shutdown
        • Logic Manager
          • config/lm/main registry key
          • Custom variables
          • Connecting UC controllers
          • Macro execution queues
          • Startup and shutdown
        • SCADA Final Aggregator
          • config/sfa/main registry key
          • Custom variables
          • Connecting UC and LM PLC controllers
          • Interface
          • Startup and shutdown
        • Control and monitoring items
          • Common item parameters
          • Item layout
          • Unit
          • Sensor
          • Validation of state value
          • Logic variable
          • Multi-updates
          • Device
          • Defaults
      • UC EI
        • Logging in
        • Navigation
        • System information
        • Units
        • Sensors
        • Log viewer
        • Disabling the interface
      • LM EI
        • Logging in
        • Navigation
        • System information
        • Logic variables
        • Macros
        • Decision rules
        • Log viewer
        • Disabling the interface
      • Equipment management
        • Cloud Manager
          • Dashboard
          • Controller management
        • Drivers
          • Structure
          • Logical to physical interfaces (LPI)
          • Physical interfaces (PHI)
        • Item scripts
          • Item actions
        • Modbus
          • Defining Modbus virtual port
          • Testing Modbus virtual port
          • Deleting Modbus virtual port
          • Generic Modbus drivers
          • Modbus slave
        • OWFS (1-Wire)
          • Setup
          • Defining OWFS bus
          • Scanning OWFS for devices
          • Deleting OWFS bus
        • SNMP
          • Collecting and sending data
          • Connecting equipment with drivers
          • Universal processing
        • Virtual items
          • Virtual drivers
      • Logic control
        • Logic control macros
          • Executing macros
          • Debugging macros
          • Macros configuration
          • Common principles of macros operation
          • System macros
          • Macros and security
          • Macros built-ins
          • Variables
          • Extending macros functionality
          • General functions
          • Item functions
          • LVar functions
          • Unit control
          • Rule management
          • Scheduled job management
          • Devices
          • Logic cycles
          • Locking functions
          • Logging
        • Decision-making matrix
          • Event analysis algorithms
          • Rule creation
          • Rule configuration
          • Tips for rule configuration
        • Scheduled jobs
          • Job creation
          • Job configuration
          • Job schedule interval
        • Logic cycles
          • Cycle creation
          • Cycle configuration
          • on_error macro
          • Performance
          • Cycles vs jobs
      • Interface development
        • UI basics
          • Development
          • Custom error pages
          • UI Favicon
        • SFA Templates
          • Template files
          • Template variables
          • Template functions
        • SFA PVT
          • Loading files from PVT Server
          • Receiving the file list
          • Receiving the newest and the oldest file
          • Image Processing
          • Disabling cache
          • Serving private data from EVA ICS Registry
          • Remote content
        • Serving structured data
          • Format conversion
          • Multi-language
          • Serving structured data from EVA ICS Registry
        • HMI file uploads
          • File upload form
          • Processing macro
          • Security and file upload limits
        • API session tokens
          • Usage
          • Expiration
          • Read-only mode
        • Supervisors
          • API locks
          • Broadcast messages
          • CLI
        • Active Directory support
          • Automatic setup
          • Manual setup
          • Active Directory configuration
          • Usage
        • Mobile clients
          • Android
          • Apple iOS and other mobile platforms
      • Integrations
        • AKCP
          • Equipment supported
          • Setup
          • Performance tuning
        • Arduino
          • Receiving commands from EVA ICS
          • Sending data to EVA ICS UC
        • Amazon Web Services
          • AWS IoT as MQTT broker
          • Amazon Polly TTS
        • CCTV Cameras
          • Uploaded images
          • Image in local network
          • Image in 3rd party network
          • Image from password-protected camera
          • Video streams
        • Denkovi
          • Equipment supported
          • Relay setup
          • smartDEN IP-32IN setup
          • Performance tuning
        • Energenie EG-PM2-LAN
          • Setup
        • Ethernet/IP
          • Drivers
          • Logic
          • Setup
        • Elastic (ELK)
          • Prepare EVA ICS
          • Configure ELK
        • Google Cloud Platform
          • Google Cloud IoT Core
          • Google Cloud TTS
        • Grafana
          • Data
          • Controls
          • Custom resources
        • Philips Hue
          • Setup
        • LoRaWAN
          • Requirements
        • Nanoleaf
          • Setup
        • Node-Red
          • Configuring EVA ICS
          • Collecting events in Node-Red
          • Processing events
          • Defining control templates
          • Controlling equipment
          • Deploying
        • Roboger
          • Servers supported
          • Setup
          • Using in macros
        • Raspberry Pi
          • Hardware recommendations
          • Installation
          • GPIO
        • Sonoff
          • Setup
        • Text-to-Speech
          • Configure audio hardware
          • Obtain cloud provider key
          • Create TTS configuration
          • Install TTSBroker Python module
          • Load tts macro extension
          • Use loaded function
          • Combine with macro
        • UniPi
          • Hardware recommendations
          • Installation
          • 1-Wire
          • Inputs/outputs
        • UPnP
          • EVA ICS controllers
          • 3rd-party equipment
        • Xiaomi Yeelight
          • Setup
      • API
        • Common methods
          • API basics
          • General functions
          • CVARs
          • Locking functions
          • Logging
          • API keys
          • User accounts
          • Notifier management
          • File management
          • Core scripts
          • Registry management
        • UC API
          • API basics
          • Item functions
          • Item management
          • 1-Wire bus via OWFS
          • Modbus ports
          • Physical interfaces (PHIs)
          • LPI and drivers
          • Data pullers
          • Devices
        • UC RESTful API
          • RESTful API basics
          • General functions
          • Item functions
          • Item management
          • 1-Wire bus via OWFS
          • Modbus ports
          • Physical interfaces (PHIs)
          • LPI and drivers
          • Data pullers
          • Devices
          • CVARs
          • Locking functions
          • Logging
          • API keys
          • User accounts
          • Notifier management
          • File management
          • Core scripts
          • Registry management
        • UC UDP API
          • Basics
          • Batch commands
          • Encryption and authentication
          • Custom packets
        • LM API
          • API basics
          • LVar functions
          • LVar management
          • Decision matrix rules
          • Logic cycles
          • Logic macros
          • Macro extensions
          • Remote controllers
          • Scheduled jobs
        • LM RESTful API
          • RESTful API basics
          • General functions
          • LVar functions
          • LVar management
          • Decision matrix rules
          • Logic cycles
          • Logic macros
          • Macro extensions
          • Remote controllers
          • Scheduled jobs
          • CVARs
          • Locking functions
          • Logging
          • API keys
          • User accounts
          • Notifier management
          • File management
          • Core scripts
          • Registry management
        • SFA API
          • API basics
          • Item functions
          • Logic cycles
          • Logic macros
          • Supervisor functions
          • Remote controllers
          • Connected clients
        • SFA RESTful API
          • RESTful API basics
          • General functions
          • Item functions
          • Logic cycles
          • Logic macros
          • Supervisor functions
          • Remote controllers
          • Connected clients
          • CVARs
          • Locking functions
          • Logging
          • API keys
          • User accounts
          • Notifier management
          • File management
          • Core scripts
          • Registry management
        • API Clients
          • EVA JS Framework
          • API client for Python
          • JSON RPC API client
      • Extension development
        • Extending HOWTO
          • Tips and tricks
          • I/O
          • Logic
          • Plug-ins
          • Extensions as packages
        • Core scripts
          • What are EVA ICS core scripts
          • What are core scripts for
          • Core script globals and functions
          • Core script events
          • Logging
          • Creating and managing core script files
          • Code examples
        • Physical interfaces for drivers
          • Required variables in a header
          • Classes and modules
          • Constructor
          • Primary methods
          • Parent methods
          • Optional methods
          • Config validation
          • Working with unit values
          • Handling timeouts
          • Handling events
          • Working with I2C/SMBus
          • Working with Modbus
          • Working with Ethernet/IP
          • Working with Modbus slave memory space
          • Working with 1-Wire via OWFS
          • Working with SNMP
          • Working with MQTT
          • Working with UDP API
          • Discovering SSDP hardware
          • Shared namespaces
          • Asynchronous I/O
          • Exceptions
          • Testing
          • DriverAPI resources
        • Logic macro extensions
          • Loading macro extension
          • Extension functions
          • Included extensions
          • Developing your own extension
        • Core plug-ins
          • Guide by example
          • Resources
        • Packages
          • Package format
          • Setting up packages
          • Setup file format
          • Keeping setup core script after install
          • Installing additional Python modules
          • Manipulating with configuration files
      • Advanced development
        • Framework development HOWTO
          • Sessions
          • API calls
          • Web socket sessions
          • Global heartbeat
          • Item state replication
          • Actions
          • Timers
      • PHIs
      • EVA ICS v3 Troubleshooting Knowledge Base
        • KB00001: SFA or LM PLC with secondaries connected keeps restarting
          • Problem
          • Solution
        • KB00002: Install / venv rebuild fails on Ubuntu 18.04 LTS / Debian 10 / RHEL 8
          • Problem
          • Solution
        • KB00003: OWFS feature setup fails on RedHat Enterprise Linux 8/Centos 8
          • Problem
          • Solution
        • KB00004: Wrong items deployed on a secondary UC or LM PLC node
          • Problem
          • Solution
        • KB00005: Timeouts during long API calls, API calls are repeated multiple times
          • Problem
          • Solution
        • KB00006: Install fails on Fedora 33
          • Problem
          • Solution
        • KB00007: InfluxDB data frames / charts begin with zero or null values
          • Problem
          • Solution
        • KB00008: Customizing EVA ICS updates
          • Problem
          • Solution
        • KB00009: Difference between “-s” and “-u” Cloud deploy options
          • Problem
          • Solution
        • KB00010: Item states are not synchronized in real-time via MQTT
          • Problem
          • Solution
        • KB00011: Renaming EVA ICS nodes
          • Problem
          • Solution
        • KB00012: Running EVA ICS under restricted users
          • Problem
          • Solution
        • KB00013: Stop EVA ICS when Registry DB is not accessible
          • Problem
          • Solution
        • KB00014: Unable to start update after a one failed
          • Problem
          • Solution
        • KB00015: A component fails to start after crash / unsuccessful upgrade etc.
          • Problem
          • Solution
        • KB00016: Active directory feature setup fails on Debian 11
          • Problem
          • Solution
        • KB00017: Dealing with startup timeouts on high-loaded nodes
          • Problem
          • Solution
        • KB00018: Preventing accidental shutdowns
          • Problem
          • Solution
        • KB00019: Python segmentation fault on Ubuntu 22.04
          • Problem
          • Solution
        • KB00020: Problems with Python 3.11
          • Problem
          • Solution
      • EVA ICS v3 License
        • TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
          • 1. Definitions.
          • 2. Grant of Copyright License.
          • 3. Grant of Patent License.
          • 4. Redistribution.
          • 5. Submission of Contributions.
          • 6. Trademarks.
          • 7. Disclaimer of Warranty.
          • 8. Limitation of Liability.
          • 9. Accepting Warranty or Additional Liability.
        • Common Clause 1
    • EVA ICS JS Framework
      • Installation
        • For web browsers
        • For Node.js
      • Quick start
        • Initialization
        • Configuration
        • Watching states and performing API calls
      • Configuring
        • API and Authentication
        • Item processing, special
        • Read-only informational variables
      • Calling API methods
        • Single API calls
        • Bulk API calls
        • Error codes
      • Worker intervals
      • Handling Framework events
      • QR code for evaHI-based apps
      • Advanced usage
        • Multi-page interfaces, external authentication
          • The primary page
          • Secondary pages
        • Authentication with front-end server
      • API reference
        • Framework
        • Toolbox
    • HMI Block UI
      • Installation
        • Installing UI App
          • EVA ICS v4
          • Package (EVA ICS v3, 3.3.2+)
        • Creating UI pages
      • Dashboard page
        • Global variables
          • title
          • url
          • default-login
          • motd
          • info-level
        • buttons
          • Simple button
          • Button with menu
          • Button with a slider
        • data
        • cameras
        • control-blocks
        • data-blocks
        • layout
        • layout-compact
        • Actions
          • Action types
          • action_params
      • Simple page
      • Sensors page
        • Global variables
          • main-page
        • charts
          • Single-item chart
          • Multiple-item chart
          • Chart with multiple timeframes
          • Multiple items and multiple timeframes
          • Legend
        • layout
        • Chart options
      • Navigation
      • Overriding and embedding
        • $eva.hmi.after_draw
        • $eva.hmi.error
        • $eva.hmi.format_camera_src
        • $eva.hmi.format_chart_config
        • $eva.hmi.prepare_layout
        • $eva.hmi.top_bar
        • Overriding logo
        • Embedding
      • Icons (default theme)
        • Data icons
        • State icons
        • Special state icons
          • circle
          • music
          • star
  • The Trademarks
    • The Trademark Supervisors
    • Usage Conditions
      • Common conditions
      • Direct usage
      • Indirect usage
        • Correct examples
        • Incorrect examples
      • Fair usage
BMA InfoSys
  • Legacy products
  • EVA ICS v3
  • System Documentation

System Documentation

  • Installation
  • What's new
  • Quick start
  • Security
  • Registry database
  • Notification system
  • Data pullers
  • Command line interfaces
  • Authentication
  • IaC and deployment
  • FAQ
  • High-load environments
  • Crash-free setup
  • Always exec
  • EVA ICS container
  • Enterprise extensions

© Copyright 2023, Bohemia Automation / Altertech. Revision 35bee3c7.

Read the Docs v: actual
Versions
actual
Downloads
On Read the Docs
Project Home
Builds