Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fbarresi/BeckhoffHttpClient
Unofficial TwinCAT function for HTTP-Client and Json conversion
https://github.com/fbarresi/BeckhoffHttpClient
api beckhoff json rest twincat twincat-ads
Last synced: about 2 months ago
JSON representation
Unofficial TwinCAT function for HTTP-Client and Json conversion
- Host: GitHub
- URL: https://github.com/fbarresi/BeckhoffHttpClient
- Owner: fbarresi
- License: mit
- Created: 2019-07-01T09:53:03.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-09-18T12:46:14.000Z (about 2 years ago)
- Last Synced: 2024-06-28T01:42:35.783Z (3 months ago)
- Topics: api, beckhoff, json, rest, twincat, twincat-ads
- Language: C#
- Size: 354 KB
- Stars: 62
- Watchers: 10
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Beckhoff Http Client
======
[](https://ci.appveyor.com/project/fbarresi/beckhoffhttpclient)
[](https://www.codacy.com/manual/fbarresi/BeckhoffHttpClient?utm_source=github.com&utm_medium=referral&utm_content=fbarresi/BeckhoffHttpClient&utm_campaign=Badge_Grade)
Unofficial TwinCAT function for HTTP requests with json conversion
This open source library allow any beckhoff PLC (Windows CE based PLCs are not supported :disappointed_relieved: - see [this issue](https://github.com/fbarresi/BeckhoffHttpClient/issues/1#issuecomment-527231410)) to make API requests with an HTTP/HTTPS client.
If you are going to buy the [TF6760 | TC3 IoT HTTPS/REST](https://www.beckhoff.com.ph/default.asp?twincat/tf6760.htm) (planned for End 2019, not realized yet - Dec '19) you should first read this page and wonder how open-source software can simplify your life.
## Key features
- **NO Licence** costs (This software is free also for commercial uses)
- support HTTP/HTTPS API calls
- support **all** API methods (GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH, MERGE, COPY)
- reads any Json body with complex nested structures (it also works with json lists of object as API response)
- parse any Json response to plc structure
## Prepare your PLC
- Install the _unofficial_ TwinCAT Function [TFU001](https://github.com/fbarresi/BeckhoffHttpClient/releases/latest) on your target system
- Install the TwinCAT Library to your project
## How to use the TwinCAT Library
### Reference the BeckhoffHttpClient Library
Download and reference the [BeckhoffHttpClient library](https://github.com/fbarresi/BeckhoffHttpClient/releases/latest) and import it to your project.
You can now declare and call a Client in your program and start using rest API.
```
PROGRAM MAIN
VAR
client : HttpClient;
END_VAR
```
```
client(
Execute:=FALSE ,
Address:= 'https://dog.ceo/api/breeds/image/random',
CallMethod:= 'GET' ,
Body:= '',
ResponseCode:= 'GVL.ResponseCode',
Response:= 'GVL.Response',
HasError=> ,
ErrorId=> );
```
### The JSON Attribute
This software can parse and convert normal DUTs (also nested DUTs) into Json object thaks to the power of [TwinCAT.JsonExtension](https://github.com/fbarresi/TwinCAT.JsonExtension).
The only things you have to do is to add the JSON attribute to your code like follows and specify if your field has another json-name or can be used with its own name.
```
TYPE JsonDUT :
STRUCT
{attribute 'json' := 'message'}
sMessage : STRING;
iResponse : INT;
{attribute 'json' := 'status'}
sStatus : STRING;
{attribute 'json' := 'numbers'}
daNumbers : ARRAY[1..10] OF DINT := [1,2,3,4,5,6,7,8,9,10];
{attribute 'json'}
child : ChildDUT;
END_STRUCT
END_TYPE
```
## Use an API header
You can setup an application-wide header using the `header.json` file placed into `C:\TwinCAT\Functions\Unofficial\BeckhoffHttpClient\`.
If no header file is provided the application will create an example file `header_example.json` you can directly rename, edit and use.
## Would you like to contribute?
Yes, please!
Try the library and feel free to open an issue or ask for support.
Don't forget to **star this project**!
## Other projects
Check other project you may be interested in:
- [BeckhoffS7Client](https://github.com/fbarresi/BeckhoffS7Client) S7 PLC communication library.
- [TwinCatAdsTool](https://github.com/fbarresi/TwinCatAdsTool) Management tool for every TwinCat PLC
## Credits
Special thanks to [JetBrains](https://www.jetbrains.com/?from=BeckhoffHttpClient) for supporting this open source project.
