DataHub™ API for Python
Prev
Next
DataHub™ API for Python
Table of Contents
1. Introduction
2. Namespace Documentation
2.1. DataHubConnection Namespace Reference
2.2. lispparse Namespace Reference
2.2.1. Function Documentation
2.2.1.1. addArg()
2.2.1.2. escaped_string()
2.2.1.3. escaped_string2()
2.2.1.4. escaped_string_auto()
2.2.1.5. escaped_string_with_options()
2.2.1.6. escaped_symbol()
2.2.1.7. initialize_terminators()
2.2.1.8. parse()
2.2.1.9. SlEscapeChar()
2.2.1.10. SlSkipFast()
2.2.1.11. SlSkipTo()
2.2.1.12. SlSkipToClosing()
2.2.1.13. SlSkipWhite()
2.2.1.14. UT_LispParseSafe()
2.2.2. Variable Documentation
2.2.2.1. BNormalTerminators
2.2.2.2. BSpecialTerminators
2.2.2.3. BSymbolTerminators
2.2.2.4. NormalTerminators
2.2.2.5. SpecialTerminators
2.2.2.6. terminators_lock
2.2.2.7. TerminatorsConfigured
2.2.2.8. UT_ParseFlagExpressions
2.3. PID Namespace Reference
2.3.1. Function Documentation
2.3.1.1. change_controller()
2.3.1.2. change_procvar()
2.3.1.3. delete_timer()
2.3.1.4. have_connection()
2.3.1.5. lost_connection()
2.3.1.6. main()
2.3.1.7. output_point()
2.3.1.8. outputControlPoints()
2.3.1.9. pid_calculate()
2.3.1.10. pid_calculate_procvar()
2.3.1.11. pid_create_points()
2.3.1.12. qualify()
2.3.1.13. recalculate_dt()
2.3.1.14. register_pid()
2.3.1.15. RegisterPointChangeCallback()
2.3.1.16. reset_timer()
2.3.1.17. start_client()
2.3.1.18. unqualifyName()
2.3.1.19. update_pids()
2.3.1.20. update_setpoint()
2.3.1.21. updateOnPointChange()
2.3.2. Variable Documentation
2.3.2.1. loop
2.4. TrendChart Namespace Reference
2.4.1. Function Documentation
2.4.1.1. have_connection()
2.4.1.2. lost_connection()
2.4.1.3. main()
2.4.1.4. on_point_changed()
2.4.1.5. registerPoint()
2.4.1.6. start_client()
2.4.1.7. update_plot()
2.4.2. Variable Documentation
2.4.2.1. ax
2.4.2.2. current_time
2.4.2.3. fig
2.4.2.4. start_time
2.4.2.5. traceDictionary
2.4.2.6. window_size
3. Class Documentation
3.1. DataHubConnection.ChangeFlags Class Reference
3.1.1. Detailed Description
3.1.2. Member Data Documentation
3.1.2.1. ECHO
3.1.2.2. FOREIGN
3.1.2.3. SYNCING
3.1.2.4. WAITING
3.2. DataHubConnection.ConnectionOptions Class Reference
3.2.1. Detailed Description
3.2.2. Constructor & Destructor Documentation
3.2.2.1. __init__()
3.2.3. Member Function Documentation
3.2.3.1. FullUsername()
3.2.3.2. HasCredentials()
3.2.3.3. HasParentSessionId()
3.2.3.4. HasProxyCredentials()
3.2.4. Member Data Documentation
3.2.4.1. AcceptInvalidCertificates
3.2.4.2. ClientCertificate
3.2.4.3. DefaultDomain
3.2.4.4. Domain
3.2.4.5. DomainListDelay
3.2.4.6. Heartbeat
3.2.4.7. Hostname
3.2.4.8. IsHttps
3.2.4.9. IsSsl
3.2.4.10. Organization
3.2.4.11. ParentSessionId
3.2.4.12. Password
3.2.4.13. Port
3.2.4.14. ProxyHostname
3.2.4.15. ProxyPassword
3.2.4.16. ProxyPort
3.2.4.17. ProxyUsername
3.2.4.18. ReconnectDelay
3.2.4.19. Timeout
3.2.4.20. Username
3.2.4.21. WebPort
3.3. DataHubConnection.DataHubConnection Class Reference
3.3.1. Detailed Description
3.3.2. Constructor & Destructor Documentation
3.3.2.1. __init__()
3.3.3. Member Function Documentation
3.3.3.1. activeHeartbeatTimers()
3.3.3.2. addPointValue()
3.3.3.3. appendPointValue()
3.3.3.4. appendPointValueMetaData()
3.3.3.5. cancelDomainListTimer()
3.3.3.6. cancelHeartbeatTimers()
3.3.3.7. cancelReconnectionTimer()
3.3.3.8. changeType()
3.3.3.9. closeConnection()
3.3.3.10. connect()
3.3.3.11. Connection_ConnectFailed()
3.3.3.12. Connection_Connecting()
3.3.3.13. Connection_ConnectSucceeded()
3.3.3.14. createPoint()
3.3.3.15. defaultOnPointChange()
3.3.3.16. dividePointValue()
3.3.3.17. DomainListEventHandler()
3.3.3.18. getCnxState()
3.3.3.19. getCnxStateString()
3.3.3.20. getDefaultDomain()
3.3.3.21. getHeartbeat()
3.3.3.22. getHostName()
3.3.3.23. getPointCache()
3.3.3.24. getPort()
3.3.3.25. getReconnectionDelay()
3.3.3.26. getTimeout()
3.3.3.27. initializePointCache()
3.3.3.28. log()
3.3.3.29. LookupOrCreatePoint()
3.3.3.30. lookupPoint()
3.3.3.31. MarkAllPointsAsNotConnected()
3.3.3.32. mathPointValue()
3.3.3.33. message_writer()
3.3.3.34. multiplyPointValue()
3.3.3.35. performConnect()
3.3.3.36. performWritePoint()
3.3.3.37. preciseTimer()
3.3.3.38. read_messages()
3.3.3.39. registerDomain()
3.3.3.40. registerPoint()
3.3.3.41. RetryEventHandler()
3.3.3.42. runAllPointChangeMethods()
3.3.3.43. runCallback()
3.3.3.44. runPointChangeMethod()
3.3.3.45. sendAlive()
3.3.3.46. sendCommand()
3.3.3.47. sendConnectionCommands()
3.3.3.48. sendHeartbeatTimes()
3.3.3.49. sendLogin()
3.3.3.50. sendWantSuccess()
3.3.3.51. setConnectionParms()
3.3.3.52. setConnState()
3.3.3.53. setDefaultDomain()
3.3.3.54. setHeartbeatTimes()
3.3.3.55. setPointTimeStamp()
3.3.3.56. setProxyParms()
3.3.3.57. setReconnectionDelay()
3.3.3.58. setSsl()
3.3.3.59. setUsername()
3.3.3.60. setWebparms()
3.3.3.61. shutdown()
3.3.3.62. startDomainListTimer()
3.3.3.63. startHeartbeatTimers()
3.3.3.64. startReconnectionTimer()
3.3.3.65. timeoutCheck()
3.3.3.66. Timer()
3.3.3.67. unregisterPoint()
3.3.3.68. writeMetadata()
3.3.3.69. writePoint()
3.3.4. Member Data Documentation
3.3.4.1. ConnectionStatus
3.3.4.2. data
3.3.4.3. dataWasRead
3.3.4.4. loop
3.3.4.5. m_aliveTimer
3.3.4.6. m_connstate
3.3.4.7. m_datamodel
3.3.4.8. m_domainlisttimer
3.3.4.9. m_retrytimer
3.3.4.10. m_timeoutTimer
3.3.4.11. message_queue
3.3.4.12. name
3.3.4.13. onAlive
3.3.4.14. onAsyncMessage
3.3.4.15. onCommand
3.3.4.16. onConnected
3.3.4.17. onConnecting
3.3.4.18. onConnectionFailure
3.3.4.19. onConnectionSuccess
3.3.4.20. onDisconnected
3.3.4.21. onEcho
3.3.4.22. onError
3.3.4.23. onLog
3.3.4.24. onPointChange
3.3.4.25. onStatusChange
3.3.4.26. onSuccess
3.3.4.27. Options
3.3.4.28. reader
3.3.4.29. writer
3.4. DataHubConnection.DataHubConnectionStatus Class Reference
3.4.1. Detailed Description
3.4.2. Member Data Documentation
3.4.2.1. Connected
3.4.2.2. Connecting
3.4.2.3. Disconnected
3.4.2.4. Idle
3.4.2.5. RetryWait
3.4.2.6. Terminated
3.5. DataHubConnection.DataHubConnectionType Class Reference
3.5.1. Detailed Description
3.5.2. Member Data Documentation
3.5.2.1. NoType
3.5.2.2. TCP
3.5.2.3. WasmWebSocket
3.5.2.4. WebSocket
3.6. lispparse.DataHubPoint Class Reference
3.6.1. Detailed Description
3.6.2. Constructor & Destructor Documentation
3.6.2.1. __init__()
3.6.3. Member Function Documentation
3.6.3.1. __repr__()
3.6.3.2. AddOnPointChangeMethod()
3.6.3.3. clear()
3.6.3.4. datetime_to_oatime()
3.6.3.5. getConfidence()
3.6.3.6. getDoubleValue()
3.6.3.7. getFlags()
3.6.3.8. getIntValue()
3.6.3.9. getName()
3.6.3.10. getQuality()
3.6.3.11. getQualityString()
3.6.3.12. getStringValue()
3.6.3.13. getType()
3.6.3.14. IsQualifiedName()
3.6.3.15. qualifyName()
3.6.3.16. RemoveOnPointChangeMethod()
3.6.3.17. setConfidence()
3.6.3.18. setDomainName()
3.6.3.19. setFlags()
3.6.3.20. setInfo()
3.6.3.21. setName()
3.6.3.22. setQuality()
3.6.3.23. setTimeStamp()
3.6.3.24. setValue()
3.6.3.25. setValueFromString()
3.6.3.26. unix_time_to_windows_time()
3.6.3.27. unqualifyName()
3.6.3.28. unqualifyNameWithDomain()
3.6.4. Member Data Documentation
3.6.4.1. CanonicalType
3.6.4.2. ChangeFlags
3.6.4.3. confidence
3.6.4.4. DomainName
3.6.4.5. flags
3.6.4.6. name
3.6.4.7. OnPointChangeMethod
3.6.4.8. quality
3.6.4.9. timestamp
3.6.4.10. value
3.7. DataHubConnection.DataHubStatus Class Reference
3.7.1. Detailed Description
3.7.2. Member Data Documentation
3.7.2.1. CMD_SYNTAX_ERROR
3.7.2.2. ERROR
3.7.2.3. FULL
3.7.2.4. INSIG
3.7.2.5. INTR
3.7.2.6. IS_CONFIG
3.7.2.7. LOCKED
3.7.2.8. NO_DOMAIN
3.7.2.9. NO_LICENSE
3.7.2.10. NO_MEMORY
3.7.2.11. NO_MSG
3.7.2.12. NO_POINT
3.7.2.13. NO_QUEUE
3.7.2.14. NO_TASK
3.7.2.15. NOT_ALLOWED
3.7.2.16. NOT_AVAILABLE
3.7.2.17. NOT_IMPLEMENTED
3.7.2.18. OK
3.7.2.19. OLD_DATA
3.7.2.20. POINT_COMPUTED
3.7.2.21. POINT_EXISTS
3.7.2.22. POINT_READONLY
3.7.2.23. REPLIED
3.7.2.24. SECURITY
3.7.2.25. TIMEOUT
3.7.2.26. TOO_LARGE
3.7.2.27. UNKNOWN
3.7.2.28. WOULDBLOCK
3.7.2.29. WRONG_TYPE
3.8. DataHubConnection.DomainFlags Class Reference
3.8.1. Detailed Description
3.8.2. Member Data Documentation
3.8.2.1. ALL
3.8.2.2. ECHO
3.8.2.3. FUTURE
3.8.2.4. METAINFO
3.8.2.5. MODEL
3.8.2.6. NOEVENT
3.8.2.7. ONCEONLY
3.8.2.8. QUALIFY
3.8.2.9. SYNC
3.8.2.10. UNREGISTER
3.9. DataHubConnection.LogSeverity Class Reference
3.9.1. Detailed Description
3.9.2. Member Data Documentation
3.9.2.1. DEBUG
3.9.2.2. ERROR
3.9.2.3. INFO
3.9.2.4. WARNING
3.10. DataHubConnection.MetadataFlags Class Reference
3.10.1. Detailed Description
3.10.2. Member Data Documentation
3.10.2.1. CLOSE
3.10.2.2. DESCRIPTION
3.10.2.3. EU
3.10.2.4. EU_HIGH
3.10.2.5. EU_LOW
3.10.2.6. INSTR_HIGH
3.10.2.7. INSTR_LOW
3.10.2.8. NONE
3.10.2.9. OPEN
3.10.2.10. ORIGIN_DESCRIPTION
3.10.2.11. ORIGIN_HOST
3.10.2.12. ORIGIN_NAME
3.10.2.13. ORIGIN_TYPE
3.10.2.14. ORIGIN_USER
3.11. DataHubConnection.ModelDomain Class Reference
3.11.1. Detailed Description
3.11.2. Constructor & Destructor Documentation
3.11.2.1. __init__()
3.11.3. Member Function Documentation
3.11.3.1. add_instruction()
3.11.3.2. sort_instructions()
3.11.4. Member Data Documentation
3.11.4.1. instruction_hash
3.11.4.2. instructions
3.11.4.3. name
3.12. DataHubConnection.ModelEmitter Class Reference
3.12.1. Detailed Description
3.12.2. Constructor & Destructor Documentation
3.12.2.1. __init__()
3.12.3. Member Function Documentation
3.12.3.1. add_domain()
3.12.3.2. emit()
3.12.3.3. map_point()
3.12.4. Member Data Documentation
3.12.4.1. conn
3.12.4.2. domains
[1/2]
3.12.4.3. domains
[2/2]
3.12.4.4. verbose
3.13. PID.MyConnection Class Reference
3.13.1. Detailed Description
3.13.2. Constructor & Destructor Documentation
3.13.2.1. __init__()
3.13.3. Member Data Documentation
3.13.3.1. model
3.14. TrendChart.MyConnection Class Reference
3.14.1. Detailed Description
3.14.2. Constructor & Destructor Documentation
3.14.2.1. __init__()
3.14.3. Member Data Documentation
3.14.3.1. latest_timestamp
3.14.3.2. model
3.14.3.3. points
3.15. PID.PID Class Reference
3.15.1. Detailed Description
3.15.2. Constructor & Destructor Documentation
3.15.2.1. __init__()
3.15.3. Member Data Documentation
3.15.3.1. amplitude
3.15.3.2. amplitudeTag
3.15.3.3. automode
3.15.3.4. automodeTag
3.15.3.5. autotime
3.15.3.6. autotimeMs
3.15.3.7. autotimeTag
3.15.3.8. ckd
3.15.3.9. ckdTag
3.15.3.10. cki
3.15.3.11. ckiTag
3.15.3.12. ckp
3.15.3.13. ckpTag
3.15.3.14. conn
3.15.3.15. domain
3.15.3.16. dt
3.15.3.17. errorDrv
3.15.3.18. errorInt
3.15.3.19. errorPrev
3.15.3.20. me
3.15.3.21. mv
3.15.3.22. mvPvTimer
3.15.3.23. mvTag
3.15.3.24. name
3.15.3.25. next_call
3.15.3.26. offset
3.15.3.27. offsetTag
3.15.3.28. pki
3.15.3.29. pkiTag
3.15.3.30. pkp
3.15.3.31. pkpTag
3.15.3.32. pv
3.15.3.33. pvTag
3.15.3.34. setpointTimer
3.15.3.35. sp
3.15.3.36. spTag
3.15.3.37. updatefrequency
3.15.3.38. updatefrequencyTag
3.16. DataHubConnection.PointFlags Class Reference
3.16.1. Detailed Description
3.16.2. Member Data Documentation
3.16.2.1. DH_ITEM_ACCESS_MASK
3.16.2.2. DH_ITEM_ACTIVE
3.16.2.3. DH_ITEM_ASSEMBLY
3.16.2.4. DH_ITEM_ATTRIBUTE
3.16.2.5. DH_ITEM_AUTO_ID
3.16.2.6. DH_ITEM_CHILD
3.16.2.7. DH_ITEM_DELETED
3.16.2.8. DH_ITEM_FIRST_VALUE
3.16.2.9. DH_ITEM_FORCE_INSIG
3.16.2.10. DH_ITEM_FORCE_WRITE
3.16.2.11. DH_ITEM_FORCE_WRITE_RO
3.16.2.12. DH_ITEM_HIDDEN
3.16.2.13. DH_ITEM_IMMUTABLE
3.16.2.14. DH_ITEM_LOCKED
3.16.2.15. DH_ITEM_MIRROR_ONLY
3.16.2.16. DH_ITEM_MODEL_BRANCH
3.16.2.17. DH_ITEM_NO_MASTER_WRITE
3.16.2.18. DH_ITEM_NO_SLAVE_WRITE
3.16.2.19. DH_ITEM_PRIVATE_ATTRIBUTE
3.16.2.20. DH_ITEM_PROCESSED
3.16.2.21. DH_ITEM_PROPERTY
3.16.2.22. DH_ITEM_PUBLISH_MODEL
3.16.2.23. DH_ITEM_READABLE
3.16.2.24. DH_ITEM_SUBASSEMBLY
3.16.2.25. DH_ITEM_TEMP_VALUE
3.16.2.26. DH_ITEM_TYPE
3.16.2.27. DH_ITEM_UNINITIALIZED
3.16.2.28. DH_ITEM_WRITABLE
3.16.2.29. DH_ITEM_ZIP_MODEL
3.16.2.30. DH_POINT_FLAGS_MIRRORED
3.17. DataHubConnection.PointMetaInfo Class Reference
3.17.1. Detailed Description
3.17.2. Member Function Documentation
3.17.2.1. __eq__()
3.17.2.2. __hash__()
3.17.2.3. __str__()
3.17.2.4. clear()
3.17.2.5. copy_from()
3.17.2.6. escaped()
3.17.2.7. set_metadata()
3.17.3. Member Data Documentation
3.17.3.1. ContactCloseLabel
3.17.3.2. ContactOpenLabel
3.17.3.3. Description
3.17.3.4. Eu
3.17.3.5. EuHigh
[1/2]
3.17.3.6. EuHigh
[2/2]
3.17.3.7. EuLow
[1/2]
3.17.3.8. EuLow
[2/2]
3.17.3.9. InstrumentHigh
[1/2]
3.17.3.10. InstrumentHigh
[2/2]
3.17.3.11. InstrumentLow
[1/2]
3.17.3.12. InstrumentLow
[2/2]
3.17.3.13. RefCount
3.17.3.14. ValidFlags
3.18. lispparse.PointQuality Class Reference
3.18.1. Detailed Description
3.18.2. Member Data Documentation
3.18.2.1. BAD
3.18.2.2. COMM_FAILURE
3.18.2.3. CONFIG_ERROR
3.18.2.4. DEVICE_FAILURE
3.18.2.5. EGU_EXCEEDED
3.18.2.6. GOOD
3.18.2.7. INITIALIZING
3.18.2.8. LAST_KNOWN
3.18.2.9. LAST_USABLE
3.18.2.10. LIMIT_MASK
3.18.2.11. LOCAL_OVERRIDE
3.18.2.12. NOT_CONNECTED
3.18.2.13. OUT_OF_SERVICE
3.18.2.14. QUALITY_MASK
3.18.2.15. SENSOR_CAL
3.18.2.16. SENSOR_FAILURE
3.18.2.17. STATUS_MASK
3.18.2.18. SUB_NORMAL
3.18.2.19. UNCERTAIN
3.19. DataHubConnection.PointRegister Class Reference
3.19.1. Detailed Description
3.19.2. Member Data Documentation
3.19.2.1. ONCEONLY
3.19.2.2. QUALIFY
3.19.2.3. SYNC
3.19.2.4. UNREGISTER
3.20. lispparse.PointType Class Reference
3.20.1. Detailed Description
3.20.2. Member Data Documentation
3.20.2.1. INT64
3.20.2.2. REAL
3.20.2.3. STRING
3.20.2.4. VOID
3.21. DataHubConnection.PreciseTimer Class Reference
3.21.1. Detailed Description
3.21.2. Constructor & Destructor Documentation
3.21.2.1. __init__()
3.21.3. Member Function Documentation
3.21.3.1. _run()
3.21.3.2. cancel()
3.21.3.3. start()
3.21.4. Member Data Documentation
3.21.4.1. _running
3.21.4.2. args
3.21.4.3. callback
3.21.4.4. initial_wait
3.21.4.5. kwargs
3.21.4.6. loop
3.21.4.7. repeat_interval
3.22. DataHubConnection.Timer Class Reference
3.22.1. Detailed Description
3.22.2. Constructor & Destructor Documentation
3.22.2.1. __init__()
3.22.3. Member Function Documentation
3.22.3.1. _run_and_repeat()
3.22.3.2. _stop_timer()
3.22.3.3. start()
3.22.3.4. stop()
3.22.4. Member Data Documentation
3.22.4.1. _run_and_repeat
3.22.4.2. _running
3.22.4.3. _stop_timer
3.22.4.4. args
3.22.4.5. callback
3.22.4.6. initial_wait
3.22.4.7. interval
3.22.4.8. kwargs
3.22.4.9. loop
3.23. TrendChart.Trace Class Reference
3.23.1. Detailed Description
3.23.2. Constructor & Destructor Documentation
3.23.2.1. __init__()
3.23.3. Member Data Documentation
3.23.3.1. extend
3.23.3.2. name
3.23.3.3. square
3.23.3.4. x
3.23.3.5. y
3.24. DataHubConnection.VariantType Class Reference
3.24.1. Detailed Description
3.24.2. Member Data Documentation
3.24.2.1. ARRAY
3.24.2.2. BOOL
3.24.2.3. BSTR
3.24.2.4. CARRAY
3.24.2.5. CY
3.24.2.6. DATE
3.24.2.7. DECIMAL
3.24.2.8. DISPATCH
3.24.2.9. EMPTY
3.24.2.10. ERROR
3.24.2.11. HRESULT
3.24.2.12. I1
3.24.2.13. I2
3.24.2.14. I4
3.24.2.15. I8
3.24.2.16. INT
3.24.2.17. INT_PTR
3.24.2.18. LPSTR
3.24.2.19. LPWSTR
3.24.2.20. NULL
3.24.2.21. PTR
3.24.2.22. R4
3.24.2.23. R8
3.24.2.24. RECORD
3.24.2.25. SAFEARRAY
3.24.2.26. STRING
3.24.2.27. UI1
3.24.2.28. UI2
3.24.2.29. UI4
3.24.2.30. UI8
3.24.2.31. UINT
3.24.2.32. UINT_PTR
3.24.2.33. UNKNOWN
3.24.2.34. USERDEFINED
3.24.2.35. VARIANT
3.24.2.36. VOID
4. File Documentation
4.1. DataHubConnection.py File Reference
4.2. introduction.md File Reference
4.3. lispparse.py File Reference
4.4. PID.py File Reference
4.5. TrendChart.py File Reference
Index