diff --git a/docs/_navbar.md b/docs/_navbar.md index 37737687..849e781c 100644 --- a/docs/_navbar.md +++ b/docs/_navbar.md @@ -9,6 +9,10 @@ * --- * [Connectors](/articles/connectors/README.md) + * [Dummy](/articles/connectors/Dummy.md) + * [WebAPI](/articles/connectors/WebAPI.md) +* --- +* [Documenation compiler](/articles/ixd/IXD.md) * --- * [Blazor rendering](/articles/blazor/README.md) * [Blazor layouts](/articles/blazor/LAYOUTS.md) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 2e4a6419..d390df08 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -8,9 +8,12 @@ * [Added members](/articles/compiler/ADDED_MEMBERS.md) * [Config file](/articles/compiler/CONFIG_FILE.md) * [Packaging and dependencies](/articles/compiler/PACKAGING.md) - +* --- +* [Documenation compiler](/articles/ixd/IXD.md) * --- * [Connectors](/articles/connectors/README.md) + * [Dummy](/articles/connectors/Dummy.md) + * [WebAPI](/articles/connectors/WebAPI.md) * --- * [Blazor rendering](/articles/blazor/README.md) * [Blazor layouts](/articles/blazor/LAYOUTS.md) diff --git a/docs/articles/connectors/Dummy.md b/docs/articles/connectors/Dummy.md new file mode 100644 index 00000000..66accf9d --- /dev/null +++ b/docs/articles/connectors/Dummy.md @@ -0,0 +1,9 @@ +# Dummy + +### [API](../../api/Ix.Connector/Ix.Connector/DummyConnector.md) + +Provides the possibility to work with PLC twins without target system. + +~~~C# + public static Plc { get; } = new(ConnectorAdapterBuilder.Build().CreateDummy()); +~~~ \ No newline at end of file diff --git a/docs/articles/connectors/README.md b/docs/articles/connectors/README.md index 62a2bb25..c9f772b3 100644 --- a/docs/articles/connectors/README.md +++ b/docs/articles/connectors/README.md @@ -306,10 +306,8 @@ HumanReadable property is the concatenation of AttributeName properties in the t HumanReadable from `TurnLightsOff` is `App.Settings.Lights off` -## [Dummy](../../api/Ix.Connector/Ix.Connector/DummyConnector.md) - -Provides the possibility to work with PLC twins without target system. +See also -## [WebAPI](../../api/Ix.Connector.Sax.WebAPI/Ix.Connector.Sax.WebAPI.md) +[Dummy Connector](Dummy.md) -Provides connectivity to S7-15XX PLC systems using WebAPI interface. \ No newline at end of file +[WebAPI Connector](WebAPI.md) \ No newline at end of file diff --git a/docs/articles/connectors/WebAPI.md b/docs/articles/connectors/WebAPI.md new file mode 100644 index 00000000..bba0c335 --- /dev/null +++ b/docs/articles/connectors/WebAPI.md @@ -0,0 +1,9 @@ +# WebAPI Connector + +## [API](../../api/Ix.Connector.S71500.WebAPI/Ix.Connector.S71500.WebAPI.md) + +Provides connectivity to S7-15XX PLC systems using WebAPI interface. + +~~~C# +public static Plc { get; } = new (ConnectorAdapterBuilder.Build().CreateWebApi(Environment.GetEnvironmentVariable("AXTARGET") ?? "10.10.101.1", "Everybody", "", true)); +~~~ \ No newline at end of file diff --git a/docs/articles/ixd/IXD.md b/docs/articles/ixd/IXD.md index 4db9b159..18b9090b 100644 --- a/docs/articles/ixd/IXD.md +++ b/docs/articles/ixd/IXD.md @@ -33,19 +33,26 @@ Docfx project will be generated with following folder structure: ``` -### 3. Generate documentation with ixd +### 3. Install ixd tool + +~~~ +dotnet tool install Ix.ixd --prerelease --local +~~~ + +### 4. Generate documentation with ixd + ``` -ixd -x $PATH_TO_AX_PROJECT -o $PATH_TO_API_FOLDER -``` +dotnet ixd -x $PATH_TO_AX_PROJECT -o $PATH_TO_API_FOLDER +======= where: `$PATH_TO_AX_PROJECT` -- is path to AX project, which contains apax.yml file `$PATH_TO_API_FOLDER` -- is path to `api` output folder, which is located in docfx project -### 4. Build and run docfx docset +### 5. Build and run docfx docset Enter following command in `docfx_project` project directory: