ignition-api 8.3.5__tar.gz → 8.3.6__tar.gz

ignition_api-8.3.6/CHANGELOG.md

@@ -0,0 +1,35 @@
+## 8.3.6 (2026-04-29)
+
+### Refactor
+
+- **system**: add historian.types submodule (#28)
+- **system**: add new overridesOnly parameter to… (#27)
+
+## 8.3.5 (2026-04-29)
+
+### Refactor
+
+- **system**: add historian.types submodule (#28)
+- **system**: add new overridesOnly parameter to… (#27)
+
+## 8.3.5.post1 (2026-04-27)
+
+### Refactor
+
+- **system**: add historian.types submodule (#28)
+- **system**: add new overridesOnly parameter to… (#27)
+
+## 8.3.5 (2026-04-22)
+
+## 8.3.4 (2026-03-04)
+
+## 8.3.3 (2026-01-21)
+
+### Refactor
+
+- **system**: add arguments to pollPartition and pollTopic (#14)
+- **ia**: fix type errors detected with ty (#13)
+
+### Perf
+
+- **devcontainer**: improve disk performance

{ignition_api-8.3.5 → ignition_api-8.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ignition_api
-Version: 8.3.5
+Version: 8.3.6
 Summary: Ignition Scripting API
 Home-page: https://github.com/ignition-devs/ignition-api
 Author: César Román
@@ -121,7 +121,7 @@ Description: # ignition-api 8.3
         
         This package includes supporting Inductive Automation's classes and interfaces.
         For more information, see documentation here:
-        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.5/index.html>.
+        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/index.html>.
         
         #### org.apache
         
@@ -153,7 +153,7 @@ Description: # ignition-api 8.3
         
         This package includes supporting classes and interfaces from the Inductive
         Automation's `org.json` package, see documentation here:
-        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.5/org/json/package-summary.html>
+        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/org/json/package-summary.html>
         
         #### org.python
         

{ignition_api-8.3.5 → ignition_api-8.3.6}/README.md

@@ -109,7 +109,7 @@ Libraries for Java 32.0.1-jre API. For more information, see documentation here:
 
 This package includes supporting Inductive Automation's classes and interfaces.
 For more information, see documentation here:
-<https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.5/index.html>.
+<https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/index.html>.
 
 #### org.apache
 
@@ -141,7 +141,7 @@ This package includes supporting classes and interfaces from Mongo Java driver
 
 This package includes supporting classes and interfaces from the Inductive
 Automation's `org.json` package, see documentation here:
-<https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.5/org/json/package-summary.html>
+<https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/org/json/package-summary.html>
 
 #### org.python
 

{ignition_api-8.3.5 → ignition_api-8.3.6}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = ignition_api
-version = 8.3.5
+version = 8.3.6
 description = Ignition Scripting API
 long_description = file: README.md
 long_description_content_type = text/markdown

ignition_api-8.3.6/src/com/inductiveautomation/historian/common/model/data/__init__.py

@@ -0,0 +1,274 @@
+from __future__ import print_function
+
+__all__ = [
+    "Annotation",
+    "AnnotationPoint",
+    "AtomicPoint",
+    "DataPoint",
+    "MetadataPoint",
+    "SnapshotCapable",
+    "StandardComplexPointType",
+    "TemporalPoint",
+]
+
+from typing import Any, List, Optional, Union
+
+from java.lang import Class, Comparable, Enum, Object, Record
+from java.time import Instant
+from java.util import UUID
+
+from com.inductiveautomation.ignition.common import QualifiedPath
+from com.inductiveautomation.ignition.common.config import PropertySet, PropertyValue
+from com.inductiveautomation.ignition.common.model.values import QualityCode
+
+
+class SnapshotCapable(object):
+    def isSnapshot(self):
+        # type: () -> bool
+        pass
+
+    def snapshotTime(self):
+        # type: () -> Optional[Instant]
+        pass
+
+    def withSnapshot(self, timestamp=None):
+        # type: (Optional[Instant]) -> SnapshotCapable
+        pass
+
+
+class TemporalPoint(Comparable):
+    def compareTo(self, other):
+        # type: (TemporalPoint) -> int
+        pass
+
+    def source(self):
+        # type: () -> QualifiedPath
+        pass
+
+    def timestamp(self):
+        # type: () -> Instant
+        pass
+
+    def type(self):
+        # type: () -> Any
+        pass
+
+    def value(self):
+        # type: () -> Any
+        pass
+
+
+class DataPoint(SnapshotCapable, TemporalPoint):
+    def quality(self):
+        # type: () -> QualityCode
+        pass
+
+    def valueClass(self):
+        # type: () -> Any
+        pass
+
+
+class AtomicPoint(DataPoint):
+    pass
+
+
+class Annotation(Record):
+    def __init__(
+        self,
+        notes,  # type: Union[str, unicode]
+        type_,  # type: Union[str, unicode]
+        author,  # type: Union[str, unicode]
+    ):
+        # type: (...) -> None
+        super(Annotation, self).__init__()
+
+    def author(self):
+        # type: () -> Union[str, unicode]
+        pass
+
+    def notes(self):
+        # type: () -> Union[str, unicode]
+        pass
+
+    def type(self):
+        # type: () -> Union[str, unicode]
+        pass
+
+
+class AnnotationPoint(Record):
+    class Builder(Object):
+        def __init__(self):
+            # type: () -> None
+            super(AnnotationPoint.Builder, self).__init__()
+
+        def annotationType(self, annotationType):
+            # type: (Union[str, unicode]) -> AnnotationPoint.Builder
+            pass
+
+        def author(self, author):
+            # type: (Union[str, unicode]) -> AnnotationPoint.Builder
+            pass
+
+        def build(self):
+            # type: () -> AnnotationPoint
+            pass
+
+        def endTime(self, endTime):
+            # type: (Instant) -> AnnotationPoint.Builder
+            pass
+
+        def identifier(
+            self,
+            identifier,  # type: Union[UUID, str, unicode]
+        ):
+            # type: (...) -> AnnotationPoint.Builder
+            pass
+
+        def lastUpdated(self, lastUpdated):
+            # type: (Instant) -> AnnotationPoint.Builder
+            pass
+
+        def notes(self, notes):
+            # type: (Union[str, unicode]) -> AnnotationPoint.Builder
+            pass
+
+        def source(self, source):
+            # type: (QualifiedPath) -> AnnotationPoint.Builder
+            pass
+
+        def startTime(self, startTime):
+            # type: (Instant) -> AnnotationPoint.Builder
+            pass
+
+    def __init__(
+        self,
+        identifier,  # type: UUID
+        source,  # type: QualifiedPath
+        value,  # type: Annotation
+        startTime,  # type: Instant
+        endTime=None,  # type: Optional[Instant]
+        lastUpdated=None,  # type: Optional[Instant]
+    ):
+        # type: (...) -> None
+        super(AnnotationPoint, self).__init__()
+        print(identifier, source, value, startTime, endTime, lastUpdated)
+
+    @staticmethod
+    def builder():
+        # type: () -> AnnotationPoint.Builder
+        pass
+
+    def endTime(self):
+        # type: () -> Optional[Instant]
+        pass
+
+    def identifier(self):
+        # type: () -> UUID
+        pass
+
+    def lastUpdated(self):
+        # type: () -> Optional[Instant]
+        pass
+
+    def source(self):
+        # type: () -> QualifiedPath
+        pass
+
+    def startTime(self):
+        # type: () -> Instant
+        pass
+
+    def timestamp(self):
+        # type: () -> Instant
+        pass
+
+    def type(self):
+        # type: () -> StandardComplexPointType
+        pass
+
+    def value(self):
+        # type: () -> Annotation
+        pass
+
+    def withSource(self, source):
+        # type: (QualifiedPath) -> AnnotationPoint
+        pass
+
+
+class MetadataPoint(Record, TemporalPoint):
+    class Builder(Object):
+        def __init__(self):
+            # type: () -> None
+            super(MetadataPoint.Builder, self).__init__()
+
+        def addValue(self, value):
+            # type: (PropertyValue) -> MetadataPoint.Builder
+            pass
+
+        def build(self):
+            # type: () -> MetadataPoint
+            pass
+
+        def quality(self, quality):
+            # type: (QualityCode) -> MetadataPoint.Builder
+            pass
+
+        def source(self, source):
+            # type: (QualifiedPath) -> MetadataPoint.Builder
+            pass
+
+        def timestamp(self, timestamp):
+            # type: (Instant) -> MetadataPoint.Builder
+            pass
+
+        def values(self, values):
+            # type: (PropertySet) -> MetadataPoint.Builder
+            pass
+
+    def __init__(
+        self,
+        value,  # type: PropertySet
+        quality,  # type: QualityCode
+        timestamp,  # type: Instant
+        source,  # type: QualifiedPath
+    ):
+        # type: (...) -> None
+        super(MetadataPoint, self).__init__()
+        print(value, quality, timestamp, source)
+
+    @staticmethod
+    def builder(metadataPoint=None):
+        # type: (Optional[MetadataPoint]) -> MetadataPoint.Builder
+        pass
+
+    @staticmethod
+    def empty(source):
+        # type: (QualifiedPath) -> MetadataPoint
+        pass
+
+    def quality(self):
+        # type: () -> QualityCode
+        pass
+
+    def withSource(self, source):
+        # type: (QualifiedPath) -> MetadataPoint
+        pass
+
+
+class StandardComplexPointType(Enum):
+    ANNOTATION = None  # type: StandardComplexPointType
+    GENERIC = None  # type: StandardComplexPointType
+    METADATA = None  # type: StandardComplexPointType
+
+    def getPointClass(self):
+        # type: () -> Class
+        pass
+
+    def getQueryOptionsClass(self):
+        # type: () -> Class
+        pass
+
+    @staticmethod
+    def values():
+        # type: () -> List[StandardComplexPointType]
+        pass

{ignition_api-8.3.5 → ignition_api-8.3.6}/src/ignition_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ignition-api
-Version: 8.3.5
+Version: 8.3.6
 Summary: Ignition Scripting API
 Home-page: https://github.com/ignition-devs/ignition-api
 Author: César Román
@@ -121,7 +121,7 @@ Description: # ignition-api 8.3
         
         This package includes supporting Inductive Automation's classes and interfaces.
         For more information, see documentation here:
-        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.5/index.html>.
+        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/index.html>.
         
         #### org.apache
         
@@ -153,7 +153,7 @@ Description: # ignition-api 8.3
         
         This package includes supporting classes and interfaces from the Inductive
         Automation's `org.json` package, see documentation here:
-        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.5/org/json/package-summary.html>
+        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/org/json/package-summary.html>
         
         #### org.python
         

{ignition_api-8.3.5 → ignition_api-8.3.6}/src/ignition_api.egg-info/SOURCES.txt

@@ -28,6 +28,10 @@ src/com/inductiveautomation/factorypmi/application/script/__init__.py
 src/com/inductiveautomation/factorypmi/application/script/builtin/__init__.py
 src/com/inductiveautomation/factorypmi/application/sqltags/__init__.py
 src/com/inductiveautomation/factorypmi/application/sqltags/project/__init__.py
+src/com/inductiveautomation/historian/__init__.py
+src/com/inductiveautomation/historian/common/__init__.py
+src/com/inductiveautomation/historian/common/model/__init__.py
+src/com/inductiveautomation/historian/common/model/data/__init__.py
 src/com/inductiveautomation/ignition/__init__.py
 src/com/inductiveautomation/ignition/alarming/__init__.py
 src/com/inductiveautomation/ignition/alarming/common/__init__.py
@@ -189,7 +193,6 @@ src/system/eam.py
 src/system/eventstream.py
 src/system/file.py
 src/system/groups.py
-src/system/historian.py
 src/system/iec61850.py
 src/system/kafka.py
 src/system/math.py
@@ -213,6 +216,8 @@ src/system/vision.py
 src/system/bacnet/__init__.py
 src/system/bacnet/enumerated.py
 src/system/bacnet/enums.py
+src/system/historian/__init__.py
+src/system/historian/types.py
 src/system/mongodb/__init__.py
 src/system/mongodb/types.py
 src/system/perspective/__init__.py

ignition_api-8.3.6/src/system/historian/types.py

@@ -0,0 +1,104 @@
+"""Historian types."""
+
+__all__ = ["annotationPoint", "dataPoint", "metadataPoint"]
+
+from typing import Any, Dict, Optional, Union
+
+from java.util import Date
+
+from com.inductiveautomation.historian.common.model.data import (
+    AnnotationPoint,
+    AtomicPoint,
+    MetadataPoint,
+)
+
+
+def annotationPoint(
+    source,  # type: Union[str, unicode]
+    startTime,  # type: Date
+    endTime=None,  # type: Optional[Date]
+    annotationType=None,  # type: Optional[Union[str, unicode]]
+    data=None,  # type: Optional[Union[str, unicode]]
+    identifier=None,  # type: Optional[Union[str, unicode]]
+):
+    # type: (...) -> AnnotationPoint
+    """Creates an annotation point that can be stored to a historian.
+
+    Annotation points represent time-based context, such as operator
+    notes, events, or system-generated markers associated with a
+    historical path.
+
+    Args:
+        source: The historical path where the annotation point will be
+            stored.
+        startTime: The start time associated with the annotation.
+        endTime: The end time associated with the annotation. If
+            omitted, the annotation has no end time. Optional.
+        annotationType: A string used to categorize the annotation
+            (for example, "marker", "note", or "event"). If omitted,
+            "marker" is used. Optional.
+        data: A string payload associated with the annotation. This can
+            contain plain text or structured data, such as JSON. If
+            omitted, an empty string is used. Optional.
+        identifier: An identifier used to indicate that an existing
+            annotation should be updated. Optional.
+
+    Returns:
+        An annotation point object that can be passed to
+        system.historian.storeAnnotations.
+    """
+    builder = AnnotationPoint.builder()
+    return builder.build()
+
+
+def dataPoint(
+    source,  # type: Union[str, unicode]
+    value,  # type: object
+    timestamp=None,  # type: Optional[Date]
+    quality=None,  # type: Optional[int]
+):
+    # type: (...) -> AtomicPoint
+    """Creates a data point that can be stored to a historian.
+
+    Data points represent individual values associated with a historical
+    path, timestamp, and quality.
+
+    Args:
+        source: The historical path where the data point will be stored.
+        value: The value to be stored in the historian.
+        timestamp: The timestamp when the data point was recorded. If
+            omitted, the current time is used. Optional.
+        quality: The quality code of the data point. If omitted, a
+            "good" quality is used. Optional.
+
+    Returns:
+        A data point object that can be passed to
+        system.historian.storeDataPoints.
+    """
+    return AtomicPoint()
+
+
+def metadataPoint(
+    source,  # type: Union[str, unicode]
+    properties,  # type: Dict[Union[str, unicode], Any]
+    timestamp,  # type: Date
+):
+    # type: (...) -> MetadataPoint
+    """Creates a metadata point that can be stored to a historian.
+
+    Metadata points allow you to store additional properties associated
+    with a historical path at a specific point in time.
+
+    Args:
+        source: The historical path where the metadata point will be
+            stored.
+        properties: A dictionary of properties to be stored as
+            historical metadata.
+        timestamp: The timestamp when the metadata point was recorded.
+
+    Returns:
+        A metadata point object that can be passed to
+        system.historian.storeMetadata.
+    """
+    builder = MetadataPoint.builder()
+    return builder.build()

{ignition_api-8.3.5 → ignition_api-8.3.6}/src/system/tag.py

@@ -210,6 +210,7 @@ def exportTags(
 def getConfiguration(
     basePath,  # type: Union[str, unicode]
     recursive=False,  # type: bool
+    overridesOnly=False,  # type: bool
 ):
     # type: (...) -> List[Dict[Union[str, unicode], Any]]
     """Retrieves Tags from the Gateway as Python dictionaries.
@@ -225,6 +226,9 @@ def getConfiguration(
             will be retrieved. Note that this will only check one level
             under the base path. True recursion would require multiple
             uses of this function at different paths. Optional.
+        overridesOnly: If True, only overridden properties from UDT
+            members will be returned. If the tag is not a UDT member,
+            this parameter is ignored. Optional.
 
     Returns:
          A List of Tag dictionaries. Nested Tags are placed in a list

ignition_api-8.3.5/CHANGELOG.md

@@ -1,14 +0,0 @@
-## 8.3.5 (2026-04-22)
-
-## 8.3.4 (2026-03-04)
-
-## 8.3.3 (2026-01-21)
-
-### Refactor
-
-- **system**: add arguments to pollPartition and pollTopic (#14)
-- **ia**: fix type errors detected with ty (#13)
-
-### Perf
-
-- **devcontainer**: improve disk performance