hms-networks / flexy-thingworx-connector Goto Github PK

The README currently has a wall of text targeting first time users, advanced users, and developers. This should be broken up to simplify the documentation for different users.

Due to the restructuring and relocation of the services provided by ConnectorHost, many parts of the user documentation must be updated.

As of Release v3.2.1, the code in services InsertDataPoint and Talk2MSyncData makes very inefficient checks.

InsertDataPoint's 'run'-function gets called for each Ewon, for each Tag, for Each datapoint. The logic for checking if 'thing' exists for that Ewon is located in this 'run'-function. A better placement would be at the start of foreach Ewon, because it only needs to run one time per Ewon to serve its function.

Same goes for the logic of handling new properties/tags, it is run for each datapoint instead of each tag.

Inefficient Placement

More Efficient Placement

Inefficient Placement of Tag-logic

More Efficient Placement of Tag-logic

The M2Web API has not migrated to an authentication method with tokens like the DataMailbox API. As such, the connector will need to be upgraded when the M2Web API supports tokens.

I have went through the steps multiple times without success, even reset with all the check-boxes in Erase & Format. Never get the *config.json in the /usr folder and no realtime log (JVM) entries. I put the older v1.1.1 JAR and jvmrun in /usr, and after reboot I immediately see the config.json file as well as the "Starting Ewon Thingworx Connector 1.0" JVM log event.

hi @alexjhawk ,

we are trying to establish a direct connection between the device and a thingworx server. If I understand the code correctly it do not use the Java SDK and the AlwaysOn protocol. For me it look like it try REST pushes with the variable values. Correct?

Second: I do not see a port I can add to the server name. What port is the software using by default? Also I'm not sure if the communication is https or HTTP. it looks like HTTP, but I assume it is https because this is an internet communication.

Third: https certificates. Are you accepting any https certificate or do you check against the java root certificates and ensure the chain in valid.

test tls and update docs

Historical data reads need to have retry. This requires a change to the extension library.

For example, submodule update commands need to be run. This is not really covered anywhere.
$git clone [email protected]:hms-networks/flexy-thingworx-connector.git --recursive
$git submodule update --init

Going through the setup process today with "the latest" files/firmware and the jvm run and eitities.xml files seem to be missing from the .zip package.

When an application key has either been deleted or revoked, there is no indication from the connector. It continues as normal and displays the same 'null' result as it would on success.

Currently, the ConnectorHost object in Thingworx, which contains the core of our Thingworx services, is displayed as a "Timer thing". This can be hard to find and potentially confusing, thus we should evaluate how to get our Thingworx connector to show up as a "connector" in Thingworx.

Feature request - status counters. Count dropped HTTP requests and add to logging

The code is using datapoint.dataType, while the correct syntax is tag.dataType. Consequence is that all properties are updated with basetype = "NUMBER". The code is failing and the log is populated with "Unknown data type" for all values.

            // Get tag data type
            var tagType;
            if (datapoint.dataType === "Int") {
                tagType = TW_DATA_TYPE_INTEGER;
            } else if (datapoint.dataType === "Bool") {
                tagType = TW_DATA_TYPE_BOOLEAN;
            } else if (datapoint.dataType === "Float") {
                tagType = TW_DATA_TYPE_NUMBER;
            } else if (datapoint.dataType === "UInt") {
                tagType = TW_DATA_TYPE_NUMBER;
            } else {
                logger.warn("Unknown data type (" + datapoint.dataType + ") for tag: " + tag.name);
                tagType = TW_DATA_TYPE_NUMBER;
            }

Evaluate the addition of a database in the Thingworx project which provides users the ability to map the values of remote updates with a service or services.

The reference guide has not been included in the most recent releases of the connector because the releases were created automatically with the build tool.

There are some sections of the reference guide that have not been moved or replicated in the README. The reference guide needs to be updated to reflect the latest version(s), or the contents should be moved to the README.

The default settings for the log level and log messages are not verbose enough. On a normal startup, only a message is shown to indicate that the connector is starting: "Starting Ewon Thingworx Connector 1.0". There should be an indication that the connector startup was complete.

The current solution does not support an easy way to read real-time values via a M2Web read. A new service should be created call ReadEwonTagValue for the GenericEwonDeviceTalk2M. This service should perform a read of a single tag value.

Add the information for the connector version's corresponding Thingworx version to the README.md file. This will reduce confusion on which version of Thingworx the connector is built for and tested against.

For httpPost errors, retry post after backoff. Implement a retry counter. Ideally this would also increment status counters.

https://support.ptc.com/help/thingworx_hc/thingworx_8_hc/en/index.html#page/ThingWorx/Help/Composer/Security/ApplicationKeys/ApplicationKeys.html

update docs to show this.

The ThingWorx Boolean data type produces a "true" or "false" string. When writing to a Flexy Boolean this results in an error because the Flexy expects a 1 or 0. My initial Fix was to change the UpdateEwonTagValue to check for boolean strings and convert them to a 1 or 0 before writing the Flexy.

There is no recovery from an error in the historical data queue for the connector. In the event of a number format exception with the time tracker, the error continues to occur repeatedly until stopped.

Can the Flexy be configured to push data via MQTT to Azure and to Thingworx in paralel?

Thingworx supports the import and export of projects, things, etc in a source control-friendly format. The import and export procedure for the source control-friendly format is different from the current procedure. The new procedure must be evaluated, tested, and documented for easy customer installation and update of the connector.