Skip to content

Feature/36 update service interface documents in demo #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aregtech merged 3 commits into from
Mar 8, 2025
Merged

Feature/36 update service interface documents in demo #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
778490a
Update documents.
aregtech Mar 8, 2025
1bbffbb
Update areg-sdk submodul
aregtech Mar 8, 2025
a1ad6e6
fixed demo 17 project
aregtech Mar 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions demo/10_locsvc/services/HelloWorld.siml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ServiceInterface FormatVersion="1.0.0">
<Overview ID="1" Name="HelloWorld" Version="1.0.1">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ServiceInterface FormatVersion="1.1.0">
<Overview ID="1" Name="HelloWorld" Version="1.1.0" Category="Private">
<Description>Simple Service Interface to demonstrate working features of AREG SDK.</Description>
</Overview>
<MethodList>
<Method ID="7" MethodType="request" Name="HelloWorld" Response="HelloWorld">
<Method ID="7" Name="HelloWorld" MethodType="Request" Response="HelloWorld">
<Description>Request to print hello world</Description>
<ParamList>
<Parameter DataType="String" ID="8" Name="roleName">
<Parameter ID="51" Name="roleName" DataType="String">
<Description>The role name of client component that requested to print hello world</Description>
</Parameter>
</ParamList>
</Method>
<Method ID="10" MethodType="response" Name="HelloWorld">
<Method ID="10" Name="HelloWorld" MethodType="Response">
<Description>The response to hello world request.</Description>
</Method>
<Method ID="14" MethodType="request" Name="ShutdownService">
<Method ID="14" Name="ShutdownService" MethodType="Request">
<Description>Sent by client to request to shutdown service and the application. This request has no response.</Description>
</Method>
<Method ID="15" MethodType="broadcast" Name="ReachedMaximum">
<Method ID="15" Name="ReachedMaximum" MethodType="Broadcast">
<Description>Triggered to notify that reached the maximum number of requests.</Description>
<ParamList>
<Parameter DataType="int32" ID="19" Name="maxNumber">
<Parameter ID="52" Name="maxNumber" DataType="int32">
<Description>The maximum number of requests.</Description>
</Parameter>
</ParamList>
</Method>
</MethodList>
<ConstantList>
<Constant DataType="int16" ID="18" Name="MaxMessages">
<Constant ID="18" Name="MaxMessages" DataType="int16">
<Value>37</Value>
<Description>The maximum number of messages to output.</Description>
</Constant>
</ConstantList>
</ServiceInterface>
</ServiceInterface>
33 changes: 16 additions & 17 deletions demo/12_pubsvc/services/HelloWorld.siml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,64 +1,63 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ServiceInterface FormatVersion="1.0.0">
<Overview ID="1" Name="HelloWorld" Version="1.0.2" isRemote="true">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ServiceInterface FormatVersion="1.1.0">
<Overview ID="1" Name="HelloWorld" Version="1.1.0" Category="Public">
<Description>Simple Service Interface to demonstrate working features of AREG SDK.</Description>
</Overview>
<DataTypeList>
<DataType ID="2" Name="sConnectedClient" Type="Structure">
<Description>The dummy structure describing connected client.</Description>
<FieldList>
<Field DataType="uint32" ID="3" Name="ccID">
<Field ID="3" Name="ccID" DataType="uint32">
<Value IsDefault="true">0</Value>
<Description>The ID of client, given by servicing component</Description>
</Field>
<Field DataType="String" ID="4" Name="ccName">
<Value IsDefault="true"/>
<Field ID="4" Name="ccName" DataType="String">
<Description>The role name of client component. Parameter received by client.</Description>
</Field>
</FieldList>
</DataType>
</DataTypeList>
<MethodList>
<Method ID="7" MethodType="request" Name="HelloWorld" Response="HelloWorld">
<Method ID="7" Name="HelloWorld" MethodType="Request" Response="HelloWorld">
<Description>Request to print hello world</Description>
<ParamList>
<Parameter DataType="String" ID="8" Name="roleName">
<Parameter ID="51" Name="roleName" DataType="String">
<Description>The role name of client component that requested to print hello world</Description>
</Parameter>
</ParamList>
</Method>
<Method ID="10" MethodType="response" Name="HelloWorld">
<Method ID="10" Name="HelloWorld" MethodType="Response">
<Description>The response to hello world request.</Description>
<ParamList>
<Parameter DataType="sConnectedClient" ID="11" Name="clientInfo">
<Parameter ID="52" Name="clientInfo" DataType="sConnectedClient">
<Description>The client information set by servicing component. If empty or invalid ID, the message output failed.</Description>
</Parameter>
</ParamList>
</Method>
<Method ID="14" MethodType="request" Name="ShutdownService">
<Method ID="14" Name="ShutdownService" MethodType="Request">
<Description>Sent by client to request to shutdown service and the application. This request has no response.</Description>
<ParamList>
<Parameter DataType="uint32" ID="16" Name="clientID">
<Parameter ID="53" Name="clientID" DataType="uint32">
<Description>The ID of client that requests to shutdown. The ID is given by service when first time client requests to output message.</Description>
</Parameter>
<Parameter DataType="String" ID="17" Name="roleName">
<Parameter ID="54" Name="roleName" DataType="String">
<Description>Service client component role name</Description>
</Parameter>
</ParamList>
</Method>
<Method ID="15" MethodType="broadcast" Name="ReachedMaximum">
<Method ID="15" Name="ReachedMaximum" MethodType="Broadcast">
<Description>Triggered to notify that reached the maximum number of requests.</Description>
<ParamList>
<Parameter DataType="int32" ID="19" Name="maxNumber">
<Parameter ID="55" Name="maxNumber" DataType="int32">
<Description>The maximum number of requests.</Description>
</Parameter>
</ParamList>
</Method>
</MethodList>
<ConstantList>
<Constant DataType="int16" ID="18" Name="MaxMessages">
<Constant ID="18" Name="MaxMessages" DataType="int16">
<Value>100</Value>
<Description>The maximum number of messages to output.</Description>
</Constant>
</ConstantList>
</ServiceInterface>
</ServiceInterface>
30 changes: 14 additions & 16 deletions demo/16_pubfsm/services/PowerManager.siml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,60 +1,58 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ServiceInterface FormatVersion="1.0.0">
<Overview ID="1" Name="PowerManager" Version="1.0.0">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ServiceInterface FormatVersion="1.1.0">
<Overview ID="1" Name="PowerManager" Version="1.1.0" Category="Private">
<Description>This is a power manager of Traffic Light Controller. It powers the lights ON and OFF.</Description>
</Overview>
<DataTypeList>
<DataType ID="3" Name="ePoweredState" Type="Enumerate" Values="default">
<DataType ID="3" Name="ePoweredState" Type="Enumeration" Values="default">
<Description>The power state of the traffic lights.</Description>
<FieldList>
<EnumEntry ID="4" Name="LightsOFF">
<Value/>
<Description>The lights are OFF</Description>
</EnumEntry>
<EnumEntry ID="5" Name="LightsON">
<Value/>
<Description>The lights are ON.</Description>
</EnumEntry>
</FieldList>
</DataType>
</DataTypeList>
<AttributeList>
<Attribute DataType="ePoweredState" ID="6" Name="LightsPowerState" Notify="OnChange">
<Attribute ID="6" Name="LightsPowerState" DataType="ePoweredState" Notify="OnChange">
<Description>The power state of the traffic lights.</Description>
</Attribute>
</AttributeList>
<MethodList>
<Method ID="2" MethodType="request" Name="PowerOn">
<Method ID="2" Name="PowerOn" MethodType="Request">
<Description>Called to power ON the traffic lights.</Description>
</Method>
<Method ID="7" MethodType="request" Name="PowerOff">
<Method ID="7" Name="PowerOff" MethodType="Request">
<Description>Called to power OFF the traffic lights.</Description>
</Method>
<Method ID="8" MethodType="request" Name="StartTrafficLight" Response="StartTrafficLight">
<Method ID="8" Name="StartTrafficLight" MethodType="Request" Response="StartTrafficLight">
<Description>Triggered to start the traffic light</Description>
</Method>
<Method ID="9" MethodType="response" Name="StartTrafficLight">
<Method ID="9" Name="StartTrafficLight" MethodType="Response">
<Description>Sent as a response to start the traffic light. The traffic light can be started when it is powered ON and in initialization state.</Description>
<ParamList>
<Parameter DataType="bool" ID="10" Name="Success">
<Parameter ID="51" Name="Success" DataType="bool">
<Description>Flag, indicating whether the operation succeeded or not.
This flag is 'true' if lights are initialization state of if traffic light is already functioning.
This flag is 'false' if lights are OFF.</Description>
</Parameter>
</ParamList>
</Method>
<Method ID="11" MethodType="request" Name="StopTrafficLight" Response="StopTrafficLight">
<Method ID="11" Name="StopTrafficLight" MethodType="Request" Response="StopTrafficLight">
<Description>Call to stop the traffic lights and put them in initialization state.</Description>
</Method>
<Method ID="12" MethodType="response" Name="StopTrafficLight">
<Method ID="12" Name="StopTrafficLight" MethodType="Response">
<Description>Response to stop the traffic lights.</Description>
<ParamList>
<Parameter DataType="bool" ID="13" Name="Success">
<Parameter ID="52" Name="Success" DataType="bool">
<Description>Flag, indicating whether the request was processed with success or not.
This flag is 'true' if traffic light are functioning or lights are in initialization state.
This flag is 'false' if traffic lights are OFF.</Description>
</Parameter>
</ParamList>
</Method>
</MethodList>
</ServiceInterface>
</ServiceInterface>
47 changes: 18 additions & 29 deletions demo/16_pubfsm/services/TrafficController.siml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,116 +1,105 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ServiceInterface FormatVersion="1.0.0">
<Overview ID="1" Name="TrafficController" Version="1.0.0" isRemote="true">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ServiceInterface FormatVersion="1.1.0">
<Overview ID="1" Name="TrafficController" Version="1.1.0" Category="Public">
<Description>This is a traffic light controlle service interface.</Description>
</Overview>
<DataTypeList>
<DataType ID="2" Name="eTrafficDirection" Type="Enumerate" Values="default">
<DataType ID="2" Name="eTrafficDirection" Type="Enumeration" Values="default">
<Description>The direction of traffic.</Description>
<FieldList>
<EnumEntry ID="4" Name="DirectionUndefiend">
<Value/>
<Description>Undefined direction.</Description>
</EnumEntry>
<EnumEntry ID="5" Name="DirectionSouthNorth">
<Value/>
<Description>The traffic direction is south-north.</Description>
</EnumEntry>
<EnumEntry ID="6" Name="DirectionEastWest">
<Value/>
<Description>The traffic direction is east-west.</Description>
</EnumEntry>
</FieldList>
</DataType>
<DataType ID="7" Name="eVehicleTrafficLight" Type="Enumerate" Values="default">
<DataType ID="7" Name="eVehicleTrafficLight" Type="Enumeration" Values="default">
<Description>The states of vehicle traffic states.</Description>
<FieldList>
<EnumEntry ID="8" Name="VehicleLightOFF">
<Value/>
<Description>The vehicle lights are OFF.</Description>
</EnumEntry>
<EnumEntry ID="9" Name="VehicleLightsInit">
<Value/>
<Description>The vehicle lights are initialized (blink yellow).</Description>
</EnumEntry>
<EnumEntry ID="10" Name="VehicleLightRed">
<Value/>
<Description>Vehicle light is red.</Description>
</EnumEntry>
<EnumEntry ID="11" Name="VehicleLightYellow">
<Value/>
<Description>Vehicle light is yellow.</Description>
</EnumEntry>
<EnumEntry ID="12" Name="VehicleLightGreen">
<Value/>
<Description>The vehicle light is green.</Description>
</EnumEntry>
</FieldList>
</DataType>
<DataType ID="13" Name="ePedestrianTrafficLight" Type="Enumerate" Values="default">
<DataType ID="13" Name="ePedestrianTrafficLight" Type="Enumeration" Values="default">
<Description>The traffic light state of pedestrians.</Description>
<FieldList>
<EnumEntry ID="14" Name="PedestrianLightOFF">
<Value/>
<Description>The pedestrian light is OFF.</Description>
</EnumEntry>
<EnumEntry ID="15" Name="PedestrianLightRed">
<Value/>
<Description>Pedestrian light is red.</Description>
</EnumEntry>
<EnumEntry ID="16" Name="PedestrianLightGreen">
<Value/>
<Description>The pedestrian light is green.</Description>
</EnumEntry>
</FieldList>
</DataType>
<DataType ID="28" Name="sTrafficLight" Type="Structure">
<Description>Describes the direction of traffic and the states of lights for vehicle and pedestrians.</Description>
<FieldList>
<Field DataType="eTrafficDirection" ID="29" Name="trafficDirection">
<Field ID="29" Name="trafficDirection" DataType="eTrafficDirection">
<Value IsDefault="true">eTrafficDirection::DirectionUndefiend</Value>
<Description>The traffic direction</Description>
</Field>
<Field DataType="eVehicleTrafficLight" ID="30" Name="lightVehicle">
<Field ID="30" Name="lightVehicle" DataType="eVehicleTrafficLight">
<Value IsDefault="true">eVehicleTrafficLight::VehicleLightOFF</Value>
<Description>The state of vehicle lights.</Description>
</Field>
<Field DataType="ePedestrianTrafficLight" ID="31" Name="lightPedestrian">
<Field ID="31" Name="lightPedestrian" DataType="ePedestrianTrafficLight">
<Value IsDefault="true">ePedestrianTrafficLight::PedestrianLightOFF</Value>
<Description>Describes the state of pedestrian lights.</Description>
</Field>
</FieldList>
</DataType>
</DataTypeList>
<AttributeList>
<Attribute DataType="sTrafficLight" ID="32" Name="TrafficSouthNorth" Notify="OnChange">
<Attribute ID="32" Name="TrafficSouthNorth" DataType="sTrafficLight" Notify="OnChange">
<Description>The south-north traffic.</Description>
</Attribute>
<Attribute DataType="sTrafficLight" ID="33" Name="TrafficEastWest" Notify="OnChange">
<Attribute ID="33" Name="TrafficEastWest" DataType="sTrafficLight" Notify="OnChange">
<Description>The east-west traffic</Description>
</Attribute>
</AttributeList>
<MethodList>
<Method ID="21" MethodType="broadcast" Name="SouthNorth">
<Method ID="21" Name="SouthNorth" MethodType="Broadcast">
<Description>Broadcasts the light states of south-north direction.</Description>
<ParamList>
<Parameter DataType="eVehicleTrafficLight" ID="23" Name="LightVehicle">
<Parameter ID="51" Name="LightVehicle" DataType="eVehicleTrafficLight">
<Description>Light state for vehicles</Description>
</Parameter>
<Parameter DataType="ePedestrianTrafficLight" ID="24" Name="LightPedestrian">
<Parameter ID="52" Name="LightPedestrian" DataType="ePedestrianTrafficLight">
<Description>Light state for pedestrians.</Description>
</Parameter>
</ParamList>
</Method>
<Method ID="25" MethodType="broadcast" Name="EastWest">
<Method ID="25" Name="EastWest" MethodType="Broadcast">
<Description>Broadcasts the light states of east-west direction.</Description>
<ParamList>
<Parameter DataType="eVehicleTrafficLight" ID="26" Name="LightVehicle">
<Parameter ID="53" Name="LightVehicle" DataType="eVehicleTrafficLight">
<Description>Light state for vehicles</Description>
</Parameter>
<Parameter DataType="ePedestrianTrafficLight" ID="27" Name="LightPedestrian">
<Parameter ID="54" Name="LightPedestrian" DataType="ePedestrianTrafficLight">
<Description>Light state for pedestrians.</Description>
</Parameter>
</ParamList>
</Method>
</MethodList>
</ServiceInterface>
</ServiceInterface>
3 changes: 3 additions & 0 deletions demo/17_winchat/17_chatter.vcxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
<Import Project="$(AregConfigDir)project.props" Label="LocalAppDataPlatform" />
</ImportGroup>
<PropertyGroup Label="UserMacros" />
<PropertyGroup Label="Vcpkg">
<VcpkgEnabled>false</VcpkgEnabled>
</PropertyGroup>
<ItemDefinitionGroup Condition="'$(ConfigShortName)'=='Debug'">
<ClCompile>
<PreprocessorDefinitions>IMPORT_SHARED_SYMBOLS=1;%(PreprocessorDefinitions)</PreprocessorDefinitions>
Expand Down
3 changes: 3 additions & 0 deletions demo/17_winchat/17_generated.vcxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
<PropertyGroup>
<OutDir>$(OutLibDir)</OutDir>
</PropertyGroup>
<PropertyGroup Label="Vcpkg">
<VcpkgEnabled>false</VcpkgEnabled>
</PropertyGroup>
<ItemDefinitionGroup Condition="'$(ConfigShortName)'=='Debug'">
<ClCompile>
<PreprocessorDefinitions>IMPORT_SHARED_SYMBOLS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
Expand Down
3 changes: 3 additions & 0 deletions demo/17_winchat/17_register.vcxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
<Import Project="$(AregConfigDir)project.props" Label="LocalAppDataPlatform" />
</ImportGroup>
<PropertyGroup Label="UserMacros" />
<PropertyGroup Label="Vcpkg">
<VcpkgEnabled>false</VcpkgEnabled>
</PropertyGroup>
<ItemDefinitionGroup Condition="'$(ConfigShortName)'=='Debug'">
<ClCompile>
<PreprocessorDefinitions>IMPORT_SHARED_SYMBOLS=1;%(PreprocessorDefinitions)</PreprocessorDefinitions>
Expand Down
Loading
Loading