Skip to content

Commit adda7b1

Browse files
committed
README Update
1 parent 28967cb commit adda7b1

1 file changed

Lines changed: 100 additions & 102 deletions

File tree

README.md

Lines changed: 100 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1,121 +1,121 @@
1-
<img src = "resources/InterSystemsXMtConnect.png" width = "40%"/>
1+
<img src = "https://raw.githubusercontent.com/phil1436/MTConnect-ObjectScript/master/resources/logo.png" alt = "Logo" width = "40%"/>
22

33
# MTConnect-ObjectScript
44

55
An [InterSystems ObjectScript](https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GCOS_INTRO) implementation, thats builds an ObjectScript Class based on a [MTConnect](https://www.mtconnect.org/) probe file and adds data from a current file.
66

77
---
88

9-
* [Installation](#installation)
10-
* [MTConnect.MSG.MTConnectRequest / Response](#mtconnectmsgmtconnectrequest--response)
11-
* [MTConnect.BO.ClassBuilder](#mtconnectboclassbuilder)
12-
* [MTConnect.MSG.CreateDataTypeRequest](#mtconnectmsgcreatedatatyperequest)
13-
* [MTConnect.DataTypesBuilder](#mtconnectdatatypesbuilder)
14-
* [MTConnect.BO.DataTypesBuilderOperation](#mtconnectbodatatypesbuilderoperation)
15-
* [Example Production](#example-production)
16-
* [DataTypes](#datatypes)
17-
* [Class Builder](#class-builder)
18-
* [Bugs](#bugs)
19-
* [Release Notes](#release-notes)
9+
- [Installation](https://github.com/phil1436/MTConnect-ObjectScript#installation)
10+
- [MTConnect.MSG.MTConnectRequest / Response](https://github.com/phil1436/MTConnect-ObjectScript#mtconnectmsgmtconnectrequest--response)
11+
- [MTConnect.BO.ClassBuilder](https://github.com/phil1436/MTConnect-ObjectScript#mtconnectboclassbuilder)
12+
- [MTConnect.MSG.CreateDataTypeRequest](https://github.com/phil1436/MTConnect-ObjectScript#mtconnectmsgcreatedatatyperequest)
13+
- [MTConnect.DataTypesBuilder](https://github.com/phil1436/MTConnect-ObjectScript#mtconnectdatatypesbuilder)
14+
- [MTConnect.BO.DataTypesBuilderOperation](https://github.com/phil1436/MTConnect-ObjectScript#mtconnectbodatatypesbuilderoperation)
15+
- [Example Production](https://github.com/phil1436/MTConnect-ObjectScript#example-production)
16+
- [DataTypes](https://github.com/phil1436/MTConnect-ObjectScript#datatypes)
17+
- [Class Builder](https://github.com/phil1436/MTConnect-ObjectScript#class-builder)
18+
- [Bugs](https://github.com/phil1436/MTConnect-ObjectScript#bugs)
19+
- [Release Notes](https://github.com/phil1436/MTConnect-ObjectScript#release-notes)
2020

2121
---
2222

2323
## Installation
2424

25-
* Download the [latest realease](https://github.com/phil1436/MTConnect-ObjectScript/releases/latest)
26-
* Extract the file
27-
* In the [InterSystems Management Portal](https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GSA_USING_PORTAL) navigate to `System Explorer > Classes`
28-
* Click on `Import`
29-
* Under *Import from File or a Directory* make sure to select *Directory*
30-
* Enter the path to the [MTConnect Folder](cls/MTConnect) under `cls/MTConnect`
31-
* Click on `Import`
25+
- Download the [latest realease](https://github.com/phil1436/MTConnect-ObjectScript/releases/latest)
26+
- Extract the file
27+
- In the [InterSystems Management Portal](https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GSA_USING_PORTAL) navigate to `System Explorer > Classes`
28+
- Click on `Import`
29+
- Under _Import from File or a Directory_ make sure to select _Directory_
30+
- Enter the path to the [MTConnect Folder](https://github.com/phil1436/MTConnect-ObjectScript/tree/master/cls/MTConnect) under `cls/MTConnect`
31+
- Click on `Import`
3232

33-
<img src="resources/ImportClassesScreenshot.png" title ="ImportClassesScreenshot" width = "60%"/>
33+
<img src="https://raw.githubusercontent.com/phil1436/MTConnect-ObjectScript/master/resources/ImportClassesScreenshot.png" title ="ImportClassesScreenshot" width = "60%"/>
3434

3535
---
3636

37-
## [MTConnect.MSG.MTConnectRequest](cls/MTConnect/MSG/MTConnectRequest.cls) / [Response](cls/MTConnect/MSG/MTConnectResponse.cls)
37+
## [MTConnect.MSG.MTConnectRequest](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/MSG/MTConnectRequest.cls) / [Response](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/MSG/MTConnectResponse.cls)
3838

39-
* `probe`: Holds the data from the probe file.
40-
* `probeFromFile`: When enabled the probe property contains an absolute path to the probe file. When disabled the probe property contains the probe file as a string.
41-
* `current`: Holds the data from the current file.
42-
* `currentToFile`: When enabled the current property contains an absolute path to the current file. When disabled the current property contains the current file as a string.
43-
* `recievedLine`(optional): Holds a received string. (Used for *cleardata*)
44-
* `className`(will be set): The complete class name of the generated class.
39+
- `probe`: Holds the data from the probe file.
40+
- `probeFromFile`: When enabled the probe property contains an absolute path to the probe file. When disabled the probe property contains the probe file as a string.
41+
- `current`: Holds the data from the current file.
42+
- `currentToFile`: When enabled the current property contains an absolute path to the current file. When disabled the current property contains the current file as a string.
43+
- `recievedLine`(optional): Holds a received string. (Used for _cleardata_)
44+
- `className`(will be set): The complete class name of the generated class.
4545

4646
---
4747

48-
## [MTConnect.BO.ClassBuilder](cls/MTConnect/BO/ClassBuilder.cls)
48+
## [MTConnect.BO.ClassBuilder](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/BO/ClassBuilder.cls)
4949

5050
A Business Operation, that builts an ObjectScript class based on a MTConnect probe file. After the class is successfully generated, the operation inserts data from a MTConnect current file.
5151

5252
### Request
5353

54-
[MTConnect.MSG.MTConnectRequest](cls/MTConnect/MSG/MTConnectRequest.cls)
54+
[MTConnect.MSG.MTConnectRequest](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/MSG/MTConnectRequest.cls)
5555

5656
### Response
5757

58-
[MTConnect.MSG.MTConnectResponse](cls/MTConnect/MSG/MTConnectResponse.cls)
58+
[MTConnect.MSG.MTConnectResponse](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/MSG/MTConnectResponse.cls)
5959

6060
### Settings
6161

6262
#### MTConnect
6363

64-
* `PackageName`: The package where the class will be generated in.
65-
* `suffixClass`: A suffix for the class name.
66-
* `Kind`: *ID* or *Name*. Sets from which attributes the class will be build.
67-
* `ClearData`: When enabled deletes all data, when a `***CL***` message is received.
68-
* `SuperClasses`: Define comma seperated superclasses for the class.
64+
- `PackageName`: The package where the class will be generated in.
65+
- `suffixClass`: A suffix for the class name.
66+
- `Kind`: _ID_ or _Name_. Sets from which attributes the class will be build.
67+
- `ClearData`: When enabled deletes all data, when a `***CL***` message is received.
68+
- `SuperClasses`: Define comma seperated superclasses for the class.
6969

7070
#### MTConnectDataTypes
7171

72-
* `GenerateDataTypes`: When enabled the MTConnect Datatypes will be generated automatically.
73-
* `DataTypesPackage`: The package where the MTConnect datatypes exists or will be generated in.
74-
* `GenerateIsValid`: When enabled generates a IsValid Method for the datatypes
75-
* `GenerateNormalize`: When enabled generates a Normalize Method for the datatypes
76-
* `GenerateLogicalToDisplay`: When enabled generates a LogicalToDisplay Method for the datatypes
77-
* `GenerateDisplayToLogical`: When enabled generates a DisplayToLogical Method for the datatypes
72+
- `GenerateDataTypes`: When enabled the MTConnect Datatypes will be generated automatically.
73+
- `DataTypesPackage`: The package where the MTConnect datatypes exists or will be generated in.
74+
- `GenerateIsValid`: When enabled generates a IsValid Method for the datatypes
75+
- `GenerateNormalize`: When enabled generates a Normalize Method for the datatypes
76+
- `GenerateLogicalToDisplay`: When enabled generates a LogicalToDisplay Method for the datatypes
77+
- `GenerateDisplayToLogical`: When enabled generates a DisplayToLogical Method for the datatypes
7878

7979
#### LOG
8080

81-
* `Log`: When enabled all changes will be written to a log file.
82-
* `LogFile`: An absolute path to the log file.
81+
- `Log`: When enabled all changes will be written to a log file.
82+
- `LogFile`: An absolute path to the log file.
8383

8484
---
8585

86-
## [MTConnect.MSG.CreateDataTypeRequest](cls/MTConnect/MSG/CreateDataTypeRequest.cls)
86+
## [MTConnect.MSG.CreateDataTypeRequest](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/MSG/CreateDataTypeRequest.cls)
8787

88-
* `Name`: The name of the datatype.
89-
* `Unit`: The unit to display the datatype with.
90-
* `DataType`: The underlying ObjectScript type (Currently only works with *%String*, *%Integer* and *%Double*).
91-
* `AllowedStringValues`: Comma separated list for the allowed values. If left empty all values will be allowed. (only used when `DataType` is *%String*)
92-
* `AllowedNumericMaxValue`: The maximum value that is allowed. If left empty all values will be allowed. (only used when `DataType` is *%Double* or *%Integer*)
93-
* `AllowedNumericMinValue`: The minimum value that is allowed. If left empty all values will be allowed. (only used when `DataType` is *%Double* or *%Integer*)
88+
- `Name`: The name of the datatype.
89+
- `Unit`: The unit to display the datatype with.
90+
- `DataType`: The underlying ObjectScript type (Currently only works with _%String_, _%Integer_ and _%Double_).
91+
- `AllowedStringValues`: Comma separated list for the allowed values. If left empty all values will be allowed. (only used when `DataType` is _%String_)
92+
- `AllowedNumericMaxValue`: The maximum value that is allowed. If left empty all values will be allowed. (only used when `DataType` is _%Double_ or _%Integer_)
93+
- `AllowedNumericMinValue`: The minimum value that is allowed. If left empty all values will be allowed. (only used when `DataType` is _%Double_ or _%Integer_)
9494

9595
---
9696

97-
## [MTConnect.DataTypesBuilder](cls/MTConnect/DataTypesBuilder.cls)
97+
## [MTConnect.DataTypesBuilder](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/DataTypesBuilder.cls)
9898

99-
Builds MTConnect Datatypes based on a [MTConnect.MSG.CreateDataTypeRequest](cls/MTConnect/MSG/CreateDataTypeRequest.cls).
99+
Builds MTConnect Datatypes based on a [MTConnect.MSG.CreateDataTypeRequest](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/MSG/CreateDataTypeRequest.cls).
100100

101101
### Execute Method
102102

103-
* `pRequest`: The [MTConnect.MSG.CreateDataTypeRequest](cls/MTConnect/MSG/CreateDataTypeRequest.cls)
104-
* `pPackage`: The package name to store the datatypes (Default is *MTConnect.DataTypes*)
105-
* `pGenerateIsValid`: If enabled generates the *IsValid* method for the datatype (enabled by default)
106-
* `pGenerateNormalize`: If enabled generates the *Normalize* method for the datatype (enabled by default)
107-
* `pGenerateDisplayToLogical`: If enabled generates the *DisplayToLogical* method for the datatype (enabled by default)
108-
* `pGenerateLogicalToDisplay`: If enabled generates the *LogicalToDisplay* method for the datatype (enabled by default)
103+
- `pRequest`: The [MTConnect.MSG.CreateDataTypeRequest](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/MSG/CreateDataTypeRequest.cls)
104+
- `pPackage`: The package name to store the datatypes (Default is _MTConnect.DataTypes_)
105+
- `pGenerateIsValid`: If enabled generates the _IsValid_ method for the datatype (enabled by default)
106+
- `pGenerateNormalize`: If enabled generates the _Normalize_ method for the datatype (enabled by default)
107+
- `pGenerateDisplayToLogical`: If enabled generates the _DisplayToLogical_ method for the datatype (enabled by default)
108+
- `pGenerateLogicalToDisplay`: If enabled generates the _LogicalToDisplay_ method for the datatype (enabled by default)
109109

110110
---
111111

112-
## [MTConnect.BO.DataTypesBuilderOperation](cls/MTConnect/BO/DataTypesBuilderOperation.cls)
112+
## [MTConnect.BO.DataTypesBuilderOperation](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/BO/DataTypesBuilderOperation.cls)
113113

114-
A Business Operation to build MTConnect Datatypes based on a [MTConnect.MSG.CreateDataTypeRequest](cls/MTConnect/MSG/CreateDataTypeRequest.cls).
114+
A Business Operation to build MTConnect Datatypes based on a [MTConnect.MSG.CreateDataTypeRequest](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/MSG/CreateDataTypeRequest.cls).
115115

116116
### Request
117117

118-
[MTConnect.MSG.CreateDataTypeRequest](cls\MTConnect\MSG\CreateDataTypeRequest.cls)
118+
[MTConnect.MSG.CreateDataTypeRequest](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/MSG/CreateDataTypeRequest.cls)
119119

120120
### Response
121121

@@ -125,76 +125,74 @@ A Business Operation to build MTConnect Datatypes based on a [MTConnect.MSG.Crea
125125

126126
#### DataType
127127

128-
* `Package`: The package name to store the datatypes (Default is *MTConnect.DataTypes*)
129-
* `IsValid`: If enabled generates the *IsValid* method for the datatype
130-
* `Normalize`: If enabled generates the *Normalize* method for the datatype
131-
* `DisplayToLogical`: If enabled generates the *DisplayToLogical* method for the datatype
132-
* `LogicalToDisplay`: If enabled generates the *LogicalToDisplay* method for the datatype
128+
- `Package`: The package name to store the datatypes (Default is _MTConnect.DataTypes_)
129+
- `IsValid`: If enabled generates the _IsValid_ method for the datatype
130+
- `Normalize`: If enabled generates the _Normalize_ method for the datatype
131+
- `DisplayToLogical`: If enabled generates the _DisplayToLogical_ method for the datatype
132+
- `LogicalToDisplay`: If enabled generates the _LogicalToDisplay_ method for the datatype
133133

134-
> Tip: Hava a look at [MTConnect.DataTypes](cls/MTConnect/DataTypes) for some default MTConnect DataTypes.
134+
> Tip: Hava a look at [MTConnect.DataTypes](https://github.com/phil1436/MTConnect-ObjectScript/tree/master/cls/MTConnect/DataTypes) for some default MTConnect DataTypes.
135135
136136
---
137137

138-
## [Example Production](cls/MTConnect/ExampleProduction)
138+
## [Example Production](https://github.com/phil1436/MTConnect-ObjectScript/tree/master/cls/MTConnect/ExampleProduction)
139139

140-
A simple [Production](cls/MTConnect/ExampleProduction/Production.cls) to show the usage of the [DataTypesBuilder Operation](cls/MTConnect/BO/DataTypesBuilderOperation.cls) and the [ClassBuilder Operation](cls/MTConnect/BO/ClassBuilder.cls).
140+
A simple [Production](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/ExampleProduction/Production.cls) to show the usage of the [DataTypesBuilder Operation](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/BO/DataTypesBuilderOperation.cls) and the [ClassBuilder Operation](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/BO/ClassBuilder.cls).
141141

142142
How to open and start the Production:
143143

144-
* In the InterSystems Management Portal navigate to `Interoperabilty > Configure > Production > Go`
145-
* Click on `Production Settings`
146-
* Navigate to `Actions > Open`
147-
* Choose `MTConnect > ExampleProduction > Production > Go`
148-
* Click on `Start`
144+
- In the InterSystems Management Portal navigate to `Interoperabilty > Configure > Production > Go`
145+
- Click on `Production Settings`
146+
- Navigate to `Actions > Open`
147+
- Choose `MTConnect > ExampleProduction > Production > Go`
148+
- Click on `Start`
149149

150150
### DataTypes
151151

152-
An example for how to use the [DataTypesBuilder Operation](cls/MTConnect/BO/DataTypesBuilderOperation.cls) to create MTConnect DataTypes.
152+
An example for how to use the [DataTypesBuilder Operation](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/BO/DataTypesBuilderOperation.cls) to create MTConnect DataTypes.
153153

154-
* From the *category* dropdown menu choose `DataTypes`
155-
* Choose the `DataTypes Process`
156-
* Navigate to `Actions > Test`
157-
* From the *Request Type* dropdown menu choose `Ens.StringRequest`
158-
* Type in the `StringValue` field *String* to generate a String MTConnect DataType
159-
**OR**
160-
* Type in the `StringValue` field *Double* to generate a Double MTConnect DataType
161-
**OR**
162-
* Type in the `StringValue` field *Inetger* to generate a Integer MTConnect DataType
163-
* Click on `Invoke Testing Service`
164-
* You can follow the *Visual Trace* to see how the DataType was created
165-
* You will find the DataTypes under `MTConnect.ExampleProduction.DataTypes`
154+
- From the _category_ dropdown menu choose `DataTypes`
155+
- Choose the `DataTypes Process`
156+
- Navigate to `Actions > Test`
157+
- From the _Request Type_ dropdown menu choose `Ens.StringRequest`
158+
- Type in the `StringValue` field _String_ to generate a String MTConnect DataType
159+
**OR**
160+
- Type in the `StringValue` field _Double_ to generate a Double MTConnect DataType
161+
**OR**
162+
- Type in the `StringValue` field _Inetger_ to generate a Integer MTConnect DataType
163+
- Click on `Invoke Testing Service`
164+
- You can follow the _Visual Trace_ to see how the DataType was created
165+
- You will find the DataTypes under `MTConnect.ExampleProduction.DataTypes`
166166

167-
![resources/ExampleProductionDataTypesDemo](resources/ExampleProductionDataTypesDemo.gif)
167+
![resources/ExampleProductionDataTypesDemo](https://raw.githubusercontent.com/phil1436/MTConnect-ObjectScript/master/resources/ExampleProductionDataTypesDemo.gif)
168168

169169
### Class Builder
170170

171-
An example for how to use the [ClassBuilder Operation](cls/MTConnect/BO/ClassBuilder.cls) to create MTConnect Class from a MTConnect [Probe](http://mtconnect.mazakcorp.com:5609/probe) and [Current](http://mtconnect.mazakcorp.com:5609/current) file.
171+
An example for how to use the [ClassBuilder Operation](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/cls/MTConnect/BO/ClassBuilder.cls) to create MTConnect Class from a MTConnect [Probe](http://mtconnect.mazakcorp.com:5609/probe) and [Current](http://mtconnect.mazakcorp.com:5609/current) file.
172172

173-
* From the *category* dropdown menu choose `Class Builder`
174-
* Choose the `Class Builder Process`
175-
* Navigate to `Actions > Test`
176-
* From the *Request Type* dropdown menu choose `Ens.Request`
177-
* Click on `Invoke Testing Service`
178-
* You can follow the *Visual Trace* to see how the MTConnect Class was created
179-
* You will find the MTConnect Class under `MTConnect.ExampleProduction.BuiltClasses`
180-
* The Operation will also generate MTConnect DataTypes based on the files. You can find them under `MTConnect.ExampleProduction.DataTypes`
173+
- From the _category_ dropdown menu choose `Class Builder`
174+
- Choose the `Class Builder Process`
175+
- Navigate to `Actions > Test`
176+
- From the _Request Type_ dropdown menu choose `Ens.Request`
177+
- Click on `Invoke Testing Service`
178+
- You can follow the _Visual Trace_ to see how the MTConnect Class was created
179+
- You will find the MTConnect Class under `MTConnect.ExampleProduction.BuiltClasses`
180+
- The Operation will also generate MTConnect DataTypes based on the files. You can find them under `MTConnect.ExampleProduction.DataTypes`
181181

182-
![resources/ExampleProductionClassBuilderDemo](resources/ExampleProductionClassBuilderDemo.gif)
182+
![resources/ExampleProductionClassBuilderDemo](https://raw.githubusercontent.com/phil1436/MTConnect-ObjectScript/master/resources/ExampleProductionClassBuilderDemo.gif)
183183

184184
---
185185

186186
## Bugs
187187

188-
* *no known bugs*
188+
- _no known bugs_
189189

190190
---
191191

192192
## [Release Notes](https://github.com/phil1436/MTConnect-ObjectScript/blob/master/CHANGELOG.md)
193193

194194
### [v0.0.3](https://github.com/phil1436/MTConnect-ObjectScript/tree/0.0.3)
195195

196-
### [v0.0.2](https://github.com/phil1436/MTConnect-ObjectScript/tree/0.0.2) ⚠️**BROKEN**⚠️
197-
198196
### [v0.0.1](https://github.com/phil1436/MTConnect-ObjectScript/tree/0.0.1)
199197

200198
---
@@ -203,4 +201,4 @@ by Jannis S. & Philipp B.
203201

204202
powered by [InterSystems](https://www.intersystems.com/).
205203

206-
*This application is **not** supported by InterSystems Corporation.*
204+
_This application is **not** supported by InterSystems Corporation._

0 commit comments

Comments
 (0)