What's Package¶
The Port package is a collection of reusable libraries. Users can develop packages by inheriting the PortObject
, then link it to a Message, allowing for straightforward usage through Message calls.
Download¶
NAME | Language | Package Manager | OS | STABLE |
---|---|---|---|---|
Port.SDK | C# | Nuget | Windows x64 | Yes |
Package Attributes¶
name | arguments | description |
---|---|---|
Port | Class Type |
Declaring a port attribute in a class designates that class as one managed by the port system. Once declared, the class can be registered as part of a package. |
Message | - |
Messages are declared, and the values defined as properties can be controlled through package calls. |
Regex | [Pattern|Type] |
It is validated through a regular expression check. If the value matches the specified regular expression, it is accepted as valid; otherwise, an input exception is triggered. |
EnumCode | - |
The Enum type is declared, allowing you to retrieve the Enum values through this declaration. |
Comment | - |
A comment is declared, allowing you to retrieve the comment through this declaration. |
Message Attributes¶
Properties declared with Message Attributes are defined as API Messages and made available to the end-user. They apply only to properties with get and set accessors, and these getters and setters can be accessed and modified via a REST API.
[Message]
public int NValue { get => 3; }
Regex Attributes¶
Properties with Regex Attributes are subjected to a regular expression check when their values are changed. If the value does not pass the validation check, it is not updated, ensuring consistency and validity of the property's value.
[Message, Regex(RegexAttribute.Ip4vRegex)]
public string Address
{
get;
set;
}
EnumCode Attributes¶
EnumCode Attributes are declared, the values of the enum can be accessed via an API. The API allows for the retrieval of information about the enumeration values, enabling external systems or users to interact with and obtain details about the enum through the API interface.
[EnumCode]
public enum TestEnum : ushort
{
_ = 0,
TestEnumItem1,
TestEnumItem2,
}
Comment Attributes¶
When Comment Attributes are declared, the comments associated with the property can be exposed through the API. This allows users or external systems to access descriptive information or documentation about the property via the API, providing context and clarity on the property's purpose or usage.
[Message,Commnet("this is a numberic")]
public int NValue { get => 3; }
How to create a packages¶
Let's develop a package. In the Port Application, all operations are grouped at the package level and function at the message level. Every operation is defined within messages, allowing users to increase code reusability through messages.
.net¶
bulb package¶
[Port(typeof(Bulb))]
public class Bulb
{
public string offon = string.Empty;
[Message]
public string OffOn
{
set => this.offon = value;
get => this.offon;
}
}
heater package¶
[Port(typeof(Heater))]
public class Heater
{
[Message]
public string Power
{
set;
get;
}
// "Property" applied to the TempProperty property.
[Property("Temp")]
public IProperty TempProperty
{
set;
get;
}
// "Message" applied to the Temp property.
[Message]
public double Temp
{
get
{
Random r = new Random(100);
// Checks if the "Arguments" parameter of TempProperty is set to "F" for Fahrenheit.
if (this.TempProperty["Arguments"] == "F")
{
return (r.NextDouble() * 9 / 5) + 32;
}
// Checks if the "Arguments" parameter of TempProperty is set to "C" for Celsius.
else if (this.TempProperty["Arguments"] == "C")
{
return r.NextDouble();
}
return 1;
}
}
}
build packages¶
How to create a port-project¶
Before starting a Port project, you need to create a root folder that defines your messages. The subfolders within this root folder are managed as groups by Port, allowing users to organize messages by group. The root folder contains files with the *.enum
extension and the structure of sub-group folders. Within the sub-group folders, message definition documents with the *.msg
extension are created.
Here's an example¶
Project Layouts¶
sample/
│
├── room1/
│ ├── *.msg
│
├── room2/
│ ├── *.msg
│
└── *.enum
How to add messages¶
To declare a message, you need to edit the *.msg
file in the sub-folder you created. By defining message data types and attributes as shown below, you can later utilize various features such as automatic logging and backup. Additionally, you can define relationships using predefined relations.
Sample message files¶
BulbOnOff enum.OffOn pkg:Blub1.OffOn
RoomTemp1 num pkg:Heater1.Temp property:{"MIN":0,"MAX":300,"Arguments":"C"}
RoomTemp2 num pkg:Heater1.Temp property:{"MIN":0,"MAX":300,"Arguments":"F"}
How to link packages¶
checking for package¶
packages list¶
Set a packages¶
[proj.toml]
Tip
If you see a message like [ERROR][open ..\proj.toml: Access is denied.]
granting administrator privileges to the port.exe program will resolve the issue.
After linking the relations to your project, you can verify the integration using the following command
How to start project¶
Once all message definitions are complete, you can start the message server based on these definitions. Before running the server, upload all updated content to the local repository by entering port push
in the console. Then, run the server with the command port run [project-name]
.
Tip
When running the server, if you include --ng ignore
in the command, it will summarize only the points where errors (NG) occur. For detailed information on these NG points, you can visit the following URL to view the NG point table: