Const, Control116 and Service116 Interfaces Changed or New in UPOS 1.16 #21

mjpcger · 2023-09-27T19:01:36Z

The DeviceClassConst, DeviceClassControl116 and services/DeviceClassService116 interfaces of those device classes that have been changed or that are new in UPOS 1.16 (DeviceMonitor, GestureControl, GraphicDisplay, IndividualRecognition, Lights, POSPower, SoundPlayer, SoundRecorder, SpeechSynthesis, VideoCapture and VoiceRecognition).

Remark: Diff shows much more changes within the Lights and POSPower interfaces as have really been made. Don't know the reason: different linefeeds convention? tabs / spaces? Problem of diff???

Added interfaces for new or changed device classes in UPOS 1.16. Updated interfaces for existing LightsConst and POSPowerConst to support added constants.

Interfaces for devices that have not been changed in UPOS 1.16 have been added. Licence headers of the other 1.16 interfaces have been changed to match the Javapos conditions.

mjpcger · 2023-09-28T19:13:38Z

Have changed some headers and created interfaces for device classe that are unchanged in UPOS 1.16

kuniss · 2023-09-28T20:41:42Z

Thanks for the PR, @mjpcger!
The Check PR was failing due to an out of memory error during javadoc generation. Seems, the processing JVM has not enough memory. I have to extend it in the GitHub Actions.
So, it is not your fault!

Bug fixed: getUrl() must return String, not int.

mjpcger · 2023-10-15T19:47:04Z

Fixed some bugs in GraphicDisplay: getURL must return String, not int...

kuniss · 2023-10-16T15:12:16Z

@mjpcger, the build failed for this PR because the javadoc runs out of memory.
Could you please do me a favor and try to put the following lines just below the java{} block in ?

javadoc {
    maxMemory = '64m'
}

And then commit it to the PR. This should re-trigger the build, automatically.

Hopefully, this will solve the compilation problem.

Increase memory for javadoc

mjpcger · 2023-10-16T15:23:41Z

I did it, unfortunately, build errors still happen.

kuniss · 2023-10-16T19:52:01Z

Seems our javadoc generation needs a lot of memory...
May I ask you for a last try to increase it t0 512MB?

javadoc {
    maxMemory = '512m'
}

Just more memory for javadoc

mjpcger · 2023-10-16T20:32:58Z

Does not look better...

Missing setter for property Storage.

mjpcger · 2023-10-16T22:32:00Z

Due to missing setter for property Storage in GestureControl, I checked again the properties for all new device classes and found no more missing setters, getters, methods or wrong data types.

Layout of service and control interfaces has been reworked to match the structure of previously defined device classes.

mjpcger · 2023-10-17T21:38:59Z

Just another rework for UPOS 1.16 interfaces, new ordering by capability, property and method in lexical order.

Comments in Const interfaces of new device classes changed to become similar to comments in other Const interfaces. Prefix OPOS_ removed from some extended error code value names.

mjpcger · 2023-10-17T22:46:13Z

And at least comment adjustments to match the style used in other Const interface classes. Additionally, OPOS_ prefix rfemoved from some extended error code values.

Removal of GraphicDisplay constant GDSP_ST_HOST_HARDTOTALS and SoundPlayer constant SPLY_ST_HOST_HARDTOTALS. Both constants are meaningless because they should be values of the Storage property of the corresponding device which specifies the source for loading or playing data. Therefore, Storage must specify the source as host or HardTotals, not both.

mjpcger · 2023-11-02T21:47:00Z

Have removed the following constants: SPLY_ST_HOST_HARDTOTALS and GDSP_ST_HOST_HARDTOTALS.

Reason: The description of both constants in the UPOS specification is senseless, both devices do not write to, they read from host or hard totals device, therefore, these constants are superfluous in practice.

UPOS specification 1.16.1 needs rework at this point.

kuniss · 2023-11-02T22:36:05Z

Have removed the following constants: SPLY_ST_HOST_HARDTOTALS and GDSP_ST_HOST_HARDTOTALS.

Reason: The description of both constants in the UPOS specification is senseless, both devices do not write to, they read from host or hard totals device, therefore, these constants are superfluous in practice.

UPOS specification 1.16.1 needs rework at this point.

@mjpcger , even if they useless - if they are defined in the UPOS specification and already implemented in OPOS we should add them to JavaPOS too! Just to have the same constants in OPOS and JavaPOS and to "consume" the constant value.

But in general you are right. All the Storage property descriptions are wrong as the devices do not write data, only read. In that sense a combination of 2 sources for reading is meaningless.

I guess, this is a simple copy'n'paste error in the specification.

mjpcger · 2023-11-03T07:53:21Z

Then at least the two constants should be marked as deprecated.

Useless constants have been re-added but marked as deprecated because they are (erroneously) present within the specification and in OPOS header files as well.

kuniss

Hi @mjpcger ,
I validated all the Control sources against the UPOS 1.16 RCDS document (dtc/22-02-18).
The comments are not for you (except for one), but general comments.
Only some of them, like parameter naming ones, you may work on. But you do not need to do it. I can do it when I merge it to the main trunk.

src/main/java/jpos/VideoCaptureControl116.java

kuniss · 2023-11-07T14:06:13Z

src/main/java/jpos/SoundPlayerConst.java

+    public static final int SPLY_ST_HOST                 = 1;
+    public static final int SPLY_ST_HARDTOTALS           = 2;
+	@Deprecated
+    public static final int SPLY_ST_HOST_HARDTOTALS      = 3;


Error in spec!
As this is a output device it does not make sense to read from 2 sources.

kuniss · 2023-11-07T14:06:49Z

src/main/java/jpos/SoundPlayerConst.java

+    // "ErrorEvent" "ErrorCodeExtended" Property Constants
+    /////////////////////////////////////////////////////////////////////
+
+    public static final int ESPLY_NOROOM        = 201;


Error in spec!
As this is an output device the storage space cannot be exhausted.

src/main/java/jpos/GestureControlConst.java

kuniss · 2023-11-07T14:53:56Z

src/main/java/jpos/GraphicDisplayConst.java

+    public static final int GDSP_ST_HOST             = 1;
+    public static final int GDSP_ST_HARDTOTALS       = 2;
+	@Deprecated
+    public static final int GDSP_ST_HOST_HARDTOTALS  = 3;


Error in spec!
Does not make any sense for an output device as it cannot read from 2 sources.

kuniss · 2023-11-07T14:54:42Z

src/main/java/jpos/GraphicDisplayConst.java

+    // "ErrorEvent" "ErrorCodeExtended" Property Constants
+    /////////////////////////////////////////////////////////////////////
+
+    public static final int EGDSP_NOROOM        = 201; // (Several)


Error in spec!
Constant does not make sense as there is nothing written to storage, so it cannot be exhausted.

src/main/java/jpos/services/DeviceMonitorService116.java

.idea/.gitignore

As recommended to allow error free javadoc processing

@Deprecation

In fact, it was forgotten to fetch the PR's head before working on it. So, now a comparison has been done and some adjustments has been made. Mainly, - sorting was corrected - @Deprecation was added to some meaningless storage constants - methods clearInput and clearInputProperties were added to SpeechSynthesis, even if they are meaningless for this category but defined in the UnifiedPOS standard

Some more memory for javadoc...

kuniss · 2023-12-07T19:01:25Z

I let the "error in spec" issue above open as well as the PR until this has been discussed and decided in the UnifiedPOS committee.

kuniss · 2023-12-08T15:37:23Z

@mjpcger, you may try the snapshots built from your contribution:
https://oss.sonatype.org/content/repositories/snapshots/org/javapos/javapos-contracts/1.16.0-SNAPSHOT/
https://oss.sonatype.org/content/repositories/snapshots/org/javapos/javapos-controls/1.16.0-SNAPSHOT/

Any feedback is appreciated.

mjpcger · 2023-12-08T18:40:54Z

Have tried to link both snapshots to JavaPOS-SPF and JavaPOS-SPF-Test. Unfortunately, the constants JposConst.JPOS_TRUE and JposConst.JPOS_FALSE remain missing. Due to a design error for property CapCardEntranceSensor of device class PointCardRW, these constants should be added at least to jpos 1.16, better to 1.15.3 as well.

mjpcger · 2023-12-08T20:48:41Z

I added my modified JposCons.class file to my projects and made a brief test with DeviceMonitor and GraphicDisplay. Seems to work as expected for both device classes.

kuniss · 2023-12-09T14:08:04Z

Have tried to link both snapshots to JavaPOS-SPF and JavaPOS-SPF-Test. Unfortunately, the constants JposConst.JPOS_TRUE and JposConst.JPOS_FALSE remain missing. Due to a design error for property CapCardEntranceSensor of device class PointCardRW, these constants should be added at least to jpos 1.16, better to 1.15.3 as well.

That's because the branch is not up to date to the master branch: pr-21-javapos116...master
I need to rebase the branch on the master...

@Deprecation

In fact, it was forgotten to fetch the PR's head before working on it. So, now a comparison has been done and some adjustments has been made. Mainly, - sorting was corrected - @Deprecation was added to some meaningless storage constants - methods clearInput and clearInputProperties were added to SpeechSynthesis, even if they are meaningless for this category but defined in the UnifiedPOS standard

kuniss · 2023-12-11T15:37:50Z

@mjpcger, I rebased the PR branch on master and published it again as second snapshot. Now the constants from 1.15.2 should be contained. Please check the 2nd snapshot release.

The snapshot artifact is available at https://oss.sonatype.org/content/repositories/snapshots/org/javapos/javapos-contracts/1.16.0-SNAPSHOT/

mjpcger · 2023-12-11T22:31:28Z

Works as expected. Use javapos-config-loader from master now because no snapshot for 1.16 is available. I would recommend to generate a snapshot from javapos-config-loader as well, with new device classes in jpos.dtd file, may be as in the sample jpos.dtd in the attached
jcl.zip file.

mjpcger · 2023-12-11T23:21:37Z

Or shall I create a pull request for the config loader?

kuniss · 2023-12-12T16:55:43Z

Yes, you are right, @mjpcger! The javapos-config-loader needs to be updated too if new categories are added.
You don't need make a PR. I want to implement code generation for all files in the loader which are category listing related. It is more than jpos.dtd! See the profile package, e.g.
In fact, there are 7 files affected. E.g., see this example for all RFIDScanner references: https://github.com/search?q=repo%3AJavaPOSWorkingGroup%2Fjavapos-config-loader%20RFIDScanner&type=code

I hope, I will find the time for that shortly.

kuniss · 2023-12-18T15:15:13Z

The JavaPOS 1.16 compliant javapos-config-loader is now also available as snapshot artifact at https://oss.sonatype.org/content/repositories/snapshots/org/javapos/javapos-config-loader/3.2.0-SNAPSHOT/.

mjpcger · 2023-12-21T19:33:25Z

The snapshot works perfectly for those device classes I have integrated into JavaPOS-SPF and JavaPOS-SPF-Test up to now: DeviceMonitor and GraphicDisplay.

kuniss · 2023-12-21T22:51:20Z

The snapshot works perfectly for those device classes I have integrated into JavaPOS-SPF and JavaPOS-SPF-Test up to now: DeviceMonitor and GraphicDisplay.

Good to hear! Does the javapos-controlssnapshot works also for you?

mjpcger · 2023-12-21T22:54:28Z

Yes, all three snapshots work as expected (GraphicDisplay and DeviceMonitor, the other device classes: I don't know).

mjpcger added 3 commits September 26, 2023 14:27

UPOS 1.16 support

2e3e73f

UPOS 1.16 support

23bd30b

Added interfaces for new or changed device classes in UPOS 1.16. Updated interfaces for existing LightsConst and POSPowerConst to support added constants.

Interface Additions and Header Changes

8662f9f

Interfaces for devices that have not been changed in UPOS 1.16 have been added. Licence headers of the other 1.16 interfaces have been changed to match the Javapos conditions.

kuniss self-assigned this Sep 28, 2023

kuniss added this to the 1.16 milestone Sep 28, 2023

kuniss added the enhancement label Sep 28, 2023

mjpcger added 2 commits October 15, 2023 21:24

Bug Fix GraphicDisplayControl116.java

9563b7c

Bug fixed: getUrl() must return String, not int.

Bug Fix GraphicDisplayService116.java

a1c5a7d

Bug fixed: getUrl() must return String, not int.

Update build.gradle

bbc204e

Increase memory for javadoc

Update build.gradle

e60a2c2

Just more memory for javadoc

mjpcger added 2 commits October 16, 2023 23:19

Update GestureControlService116.java

fd2c70d

Missing setter for property Storage.

Update GestureControlControl116.java

99e6c4f

Missing setter for property Storage.

mjpcger added 2 commits October 17, 2023 23:25

Layout Rework

57ee408

Layout of service and control interfaces has been reworked to match the structure of previously defined device classes.

Layout Rework

3d3c68a

Layout of service and control interfaces has been reworked to match the structure of previously defined device classes.

Layout Rework

cd28e3b

Comments in Const interfaces of new device classes changed to become similar to comments in other Const interfaces. Prefix OPOS_ removed from some extended error code value names.

Useless Constants Re-Added

d01fcba

Useless constants have been re-added but marked as deprecated because they are (erroneously) present within the specification and in OPOS header files as well.

kuniss approved these changes Nov 7, 2023

View reviewed changes

Update build.gradle

e895489

As recommended to allow error free javadoc processing

Update build.gradle

54e6073

Some more memory for javadoc...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Const, Control116 and Service116 Interfaces Changed or New in UPOS 1.16 #21

Const, Control116 and Service116 Interfaces Changed or New in UPOS 1.16 #21

mjpcger commented Sep 27, 2023

mjpcger commented Sep 28, 2023

kuniss commented Sep 28, 2023

mjpcger commented Oct 15, 2023

kuniss commented Oct 16, 2023

mjpcger commented Oct 16, 2023

kuniss commented Oct 16, 2023

mjpcger commented Oct 16, 2023

mjpcger commented Oct 16, 2023

mjpcger commented Oct 17, 2023

mjpcger commented Oct 17, 2023

mjpcger commented Nov 2, 2023

kuniss commented Nov 2, 2023

mjpcger commented Nov 3, 2023

kuniss left a comment •

edited

kuniss Nov 7, 2023

kuniss Nov 7, 2023

kuniss Nov 7, 2023

kuniss Nov 7, 2023

kuniss commented Dec 7, 2023

kuniss commented Dec 8, 2023

mjpcger commented Dec 8, 2023

mjpcger commented Dec 8, 2023

kuniss commented Dec 9, 2023

kuniss commented Dec 11, 2023

mjpcger commented Dec 11, 2023

mjpcger commented Dec 11, 2023

kuniss commented Dec 12, 2023 •

edited

kuniss commented Dec 18, 2023

mjpcger commented Dec 21, 2023

kuniss commented Dec 21, 2023

mjpcger commented Dec 21, 2023

Const, Control116 and Service116 Interfaces Changed or New in UPOS 1.16 #21

Are you sure you want to change the base?

Const, Control116 and Service116 Interfaces Changed or New in UPOS 1.16 #21

Conversation

mjpcger commented Sep 27, 2023

mjpcger commented Sep 28, 2023

kuniss commented Sep 28, 2023

mjpcger commented Oct 15, 2023

kuniss commented Oct 16, 2023

mjpcger commented Oct 16, 2023

kuniss commented Oct 16, 2023

mjpcger commented Oct 16, 2023

mjpcger commented Oct 16, 2023

mjpcger commented Oct 17, 2023

mjpcger commented Oct 17, 2023

mjpcger commented Nov 2, 2023

kuniss commented Nov 2, 2023

mjpcger commented Nov 3, 2023

kuniss left a comment • edited

Choose a reason for hiding this comment

kuniss Nov 7, 2023

Choose a reason for hiding this comment

kuniss Nov 7, 2023

Choose a reason for hiding this comment

kuniss Nov 7, 2023

Choose a reason for hiding this comment

kuniss Nov 7, 2023

Choose a reason for hiding this comment

kuniss commented Dec 7, 2023

kuniss commented Dec 8, 2023

mjpcger commented Dec 8, 2023

mjpcger commented Dec 8, 2023

kuniss commented Dec 9, 2023

kuniss commented Dec 11, 2023

mjpcger commented Dec 11, 2023

mjpcger commented Dec 11, 2023

kuniss commented Dec 12, 2023 • edited

kuniss commented Dec 18, 2023

mjpcger commented Dec 21, 2023

kuniss commented Dec 21, 2023

mjpcger commented Dec 21, 2023

kuniss left a comment •

edited

kuniss commented Dec 12, 2023 •

edited