Document Interfaces using PHENOM Portal - Revision history

Chris at 15:05, 16 January 2026

2026-01-16T15:05:09Z

@@ Line 6: / Line 6: @@
 Start by downloading this data model: [[File:robot_model.face]]
-===Switch to Manage Mode===
+Create a new project with this model.  If you need any help, consult the following tutorial: [[Creating a Project from an Existing Model]].
 ==Prelude: Views, View-Characteristic, and Paths - What and Why==

Jen at 18:15, 22 October 2025

2025-10-22T18:15:54Z

← Older revision		Revision as of 14:15, 22 October 2025
Line 121:		Line 121:

	===Select a Platform Type===		===Select a Platform Type===

			[[Category:UserGuide\|0043_Document_Interfaces_using_PHENOM_Portal]]

Chris: /* Prelude: Views, View-Characteristic, and Paths - What and Why */

2022-08-29T20:13:45Z

Prelude: Views, View-Characteristic, and Paths - What and Why

← Older revision		Revision as of 16:13, 29 August 2022
Line 68:		Line 68:
	In the task of documenting the Simple Operating Robot Data Interface, our main focus will be in [[View]]s. Views can be understood as the documentation of messages that the interface describes. A view documents a message interface, and each view-characteristic documents a single field of the message. More specifically, a view-characteristic contains information about the logical level of the message field (such as the measurement and unit being used) as well as information about the conceptual level of the message field (which entities and properties of entities are being talked about).		In the task of documenting the Simple Operating Robot Data Interface, our main focus will be in [[View]]s. Views can be understood as the documentation of messages that the interface describes. A view documents a message interface, and each view-characteristic documents a single field of the message. More specifically, a view-characteristic contains information about the logical level of the message field (such as the measurement and unit being used) as well as information about the conceptual level of the message field (which entities and properties of entities are being talked about).

	If you click on a view-characteristic, you will see that each has a name, an observable, a measurement and axis (which further characterizes the observable), and a path documenting the entities and its context. Path development is the primary focus of this assignment - paths communicate the semantics of message fields in a machine understandable fashion. Engineer-written documentation for data coming in over the wire might indicate "Temperature of the main unit of an air system's propulsion system." which, though concise and informative, might not mean much to a machine. Paths allow us to write standardized descriptions of view-attributes, linking together different entities, such as engines, propulsion systems, and air vehicles, to create semantic, machine-readable documentation for the contents of a message. Below is an example view attribute describing the message field documented in the sentence above.		If you click on a view-characteristic, you will see that each has a name, an [[observable]], a measurement and axis (which further characterizes the observable), and a path documenting the entities and its context. Path development is the primary focus of this assignment - paths communicate the semantics of message fields in a machine understandable fashion. Engineer-written documentation for data coming in over the wire might indicate "Temperature of the main unit of an air system's propulsion system." which, though concise and informative, might not mean much to a machine. Paths allow us to write standardized descriptions of view-attributes, linking together different entities, such as engines, propulsion systems, and air vehicles, to create semantic, machine-readable documentation for the contents of a message. Below is an example view attribute describing the message field documented in the sentence above.

	[[File:Phenom-tutorial-documenting-interface-example.png\|thumb\|none]]		[[File:Phenom-tutorial-documenting-interface-example.png\|thumb\|none]]

Chris: /* Part 1: Documenting Robot Position Status */

2022-08-19T18:06:05Z

Part 1: Documenting Robot Position Status

@@ Line 75: / Line 75: @@
 == Part 1: Documenting Robot Position Status==
-The first message interface we have to implement is for communicating the '''Robot_Position_Status - the message that returns position information of the robot.''' We are given the following interface description:
+The first message interface we have to implement is for communicating the '''Robot_Position_Status'''.  We are given the following interface description:
 {| class="wikitable"
-|+ Caption text
+|+ Robot_Position_Status - This message returns the position information of the robot.
 |-
 ! Field ID !! Name & Description !! Unit !! Data Type
@@ Line 90: / Line 90: @@
 | 4 || '''Altitude''' <br/> The altitude value expressed in MSL. || Meters || Float
 |}

Chris: /* Part 1: Documenting Robot Position Status */

2022-08-19T16:13:27Z

Part 1: Documenting Robot Position Status

← Older revision		Revision as of 12:13, 19 August 2022
Line 82:		Line 82:
	! Field ID !! Name & Description !! Unit !! Data Type		! Field ID !! Name & Description !! Unit !! Data Type
	\|-		\|-
	\| 1 \|\| '''Robot_Id'''An alphanumeric string indicating the unique identifier of the robot system. \|\| UTF-8 \|\| String		\| 1 \|\| '''Robot_Id''' <br/> An alphanumeric string indicating the unique identifier of the robot system. \|\| UTF-8 \|\| String
	\|-		\|-
	\| 2 \|\| '''Latitude''' <br/> The WGS-84 latitude value. \|\| Radians \|\| Double		\| 2 \|\| '''Latitude''' <br/> The WGS-84 latitude value. \|\| Radians \|\| Double
	\|-		\|-
	\| 3 \|\| '''Longitude'''The WGS-84 longitude value. \|\| Radians \|\| Double		\| 3 \|\| '''Longitude''' <br/> The WGS-84 longitude value. \|\| Radians \|\| Double
	\|-		\|-
	\| 4 \|\| '''Altitude'''The altitude value expressed in MSL. \|\| Meters \|\| Float		\| 4 \|\| '''Altitude''' <br/> The altitude value expressed in MSL. \|\| Meters \|\| Float
	\|}		\|}

Chris: /* Part 1: Documenting Robot Position Status */

2022-08-19T16:13:01Z

Part 1: Documenting Robot Position Status

← Older revision		Revision as of 12:13, 19 August 2022
Line 84:		Line 84:
	\| 1 \|\| '''Robot_Id'''An alphanumeric string indicating the unique identifier of the robot system. \|\| UTF-8 \|\| String		\| 1 \|\| '''Robot_Id'''An alphanumeric string indicating the unique identifier of the robot system. \|\| UTF-8 \|\| String
	\|-		\|-
	\| 2 \|\| '''Latitude''' <~~nowiki~~ /> The WGS-84 latitude value. \|\| Radians \|\| Double		\| 2 \|\| '''Latitude''' <br/> The WGS-84 latitude value. \|\| Radians \|\| Double
	\|-		\|-
	\| 3 \|\| '''Longitude'''The WGS-84 longitude value. \|\| Radians \|\| Double		\| 3 \|\| '''Longitude'''The WGS-84 longitude value. \|\| Radians \|\| Double

Chris: /* Part 1: Documenting Robot Position Status */

2022-08-19T16:12:18Z

Part 1: Documenting Robot Position Status

← Older revision		Revision as of 12:12, 19 August 2022
Line 84:		Line 84:
	\| 1 \|\| '''Robot_Id'''An alphanumeric string indicating the unique identifier of the robot system. \|\| UTF-8 \|\| String		\| 1 \|\| '''Robot_Id'''An alphanumeric string indicating the unique identifier of the robot system. \|\| UTF-8 \|\| String
	\|-		\|-
	\| 2 \|\| '''Latitude'''The WGS-84 latitude value. \|\| Radians \|\| Double		\| 2 \|\| '''Latitude''' <nowiki /> The WGS-84 latitude value. \|\| Radians \|\| Double
	\|-		\|-
	\| 3 \|\| '''Longitude'''The WGS-84 longitude value. \|\| Radians \|\| Double		\| 3 \|\| '''Longitude'''The WGS-84 longitude value. \|\| Radians \|\| Double

Chris at 16:11, 19 August 2022

2022-08-19T16:11:08Z

← Older revision		Revision as of 12:11, 19 August 2022
Line 82:		Line 82:
	! Field ID !! Name & Description !! Unit !! Data Type		! Field ID !! Name & Description !! Unit !! Data Type
	\|-		\|-
	\| 1 \|\| '''Robot_Id'''		\| 1 \|\| '''Robot_Id'''An alphanumeric string indicating the unique identifier of the robot system. \|\| UTF-8 \|\| String
	An alphanumeric string indicating the unique identifier of the robot system. \|\| UTF-8 \|\| String
	\|-		\|-
	\| 2 \|\| '''Latitude''' \|\| Radians \|\| Double		\| 2 \|\| '''Latitude'''The WGS-84 latitude value. \|\| Radians \|\| Double
	\|-		\|-
	\| 3 \|\| '''Longitude''' \|\| Radians \|\| Double		\| 3 \|\| '''Longitude'''The WGS-84 longitude value. \|\| Radians \|\| Double
	\|-		\|-
	\| 4 \|\| '''Altitude''' \|\| Meters \|\| Float		\| 4 \|\| '''Altitude'''The altitude value expressed in MSL. \|\| Meters \|\| Float
	\|}		\|}

Chris at 16:09, 19 August 2022

2022-08-19T16:09:36Z

@@ Line 6: / Line 6: @@
 Start by downloading this data model: [[File:robot_model.face]]
 ===Switch to Manage Mode===
 All model management functions are performed in the [[Manage|Manage Models]] section of PHENOM.  After logging in, please click on the [[Manage|Manage Models]] icon.
@@ Line 74: / Line 73: @@
 Take a look at the path and see if you can connect it to the meaning intended by the engineer from the previous paragraph. Note that this page also captures how the measurement of this concept is expressed (i.e., measurement units and frame of reference).  This information is used to construct the [[Logical Data Model]].

Chris: /* Prelude: Views, View-Characteristic, and Paths - What and Why */

2022-08-19T14:28:13Z

Prelude: Views, View-Characteristic, and Paths - What and Why

← Older revision		Revision as of 10:28, 19 August 2022
Line 72:		Line 72:

	[[File:Phenom-tutorial-documenting-interface-example.png\|thumb\|none]]		[[File:Phenom-tutorial-documenting-interface-example.png\|thumb\|none]]

			Take a look at the path and see if you can connect it to the meaning intended by the engineer from the previous paragraph. Note that this page also captures how the measurement of this concept is expressed (i.e., measurement units and frame of reference). This information is used to construct the [[Logical Data Model]].