Siemens.Collaboration.Net.TiaPortal.Openness.Hmi.Extensions 19.0.1725480563

TIA Portal Openness HMI Extensions

Includes

Siemens Collaboration Openness HMI Extensions provide extensions for Siemens Engineering HMI types to help you write cleaner and more efficient code.

Installation

• install package Siemens.Collaboration.Net.TiaPortal.Openness.Hmi.Extensions and select a matching version (17.* = TIA Portal V17, 18.* = TIA Portal V18)
• reload and build the project

Dependencies

By installing this package, the following packages are automatically installed and must not be installed individually:

• TIA Portal Openness References
  All Siemens.Engineering assemblies are referenced automatically. Please see README for further documentation.

• TIA Portal Openness Resolver
  Using Api.Global.Openness().Initialize() will resolve all Siemens.Engineering assemblies at runtime. Please see README for further documentation.

• TIA Portal Openness Extensions
  TIA Portal Openness Core Extensions for Siemens Engineering types. Please see README for further documentation.

Extensions

TIA Portal Openness HMI Extensions provide a lot of extensions for various Siemens Engineering HMI types. The following chapters are an excerpt of the most frequently used extensions.

HMI Unified

Hardware

Get all HmiSoftware in this project recursively

IEnumerable<HmiSoftware> hmiSoftware = tiaProject.AllHmiSoftwares()

Get the HmiSoftware of a Device

HmiSoftware hmiSoftware = device.AsHmiSoftware();

Get the Device of a HmiSoftware

Device device = hmiSoftware.Device();

Screens

Get a screen by name or create it if not found

Screen conveyorsScreen = screens.AddOrGet("Conveyors");

Get a screen item by name or create it if not found

HmiSlider velocitySlider = screen.ScreenItems.AddOrGet<HmiSlider>("TargetVelocity");

Return the parent composition of a screen object

HmiScreenComposition screens = screen.ParentComposition();

Type safe access to all items of a specific type in a given screen

var textBoxes = screen.ScreenItems.Typed<HmiTextBox>();

Get all buttons

var buttons = screen.Buttons();

Get all sliders

var sliders = screen.Sliders();

Get all alarm controls

var alarmControls = screen.AlarmControls();

HMI Advanced/Professional

Get all HmiTarget in this project recursively

IEnumerable<HmiTarget> hmiTargets = tiaProject.AllHmiTargets()

Get the HmiTarget of a Device

HmiTarget hmiTarget = device.AsHmiTarget();

Get the Device of a HmiTarget

Device device = hmiTarget.Device();