Quick Start¶

Port operates by reflecting messages in the most recently updated repository. Try creating and editing a basic project to see how you can modify and configure projects. Follow along to understand the process better.

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.

Attributes¶

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; }

Download¶

Sample code (.net)¶

bulb package¶

 public class Port : PortObject
 {
     public Port()
     {

     }

     public override bool Init()
     {
        // initialized method
     }

     public override void Dispose()
     {

     } 

     private string status = "On";

     [Message]
     public string OnOff { get => { return status == "On" ? "Off" : "On"; }} 

 }

heater package¶

 public class Port : PortObject
 {
     public Port()
     {

     }

     public override bool Init()
     {
        // initialized method
     }

     public override void Dispose()
     {

     } 

     [Message]
     public double GetTemperature { get => { var rand = new Random(); return rand.Next(); }

 }

Here's an example¶

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/
│
├── subgroup1/
│   ├── *.msg
│
├── subgroup2/
│   ├── *.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¶

 bulb1          enum.OnOff   pkg:bulb1.PowerOnOff         
 bulb2          enum.OnOff   pkg:bulb2.PowerOnOff       property:{"Arguments":"1,0"}
 heater1temp    num          pkg:heater1.GetTemperature property:{"MIN":0,"MAX":300}
 heater2temp    num          pkg:heater2.GetTemperature property:{"MIN":200,"MAX":500}          

How to link packages¶

Check packages¶

Add packages¶

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].

Good luck!¶