lb_assets 1.0.0 copy "lb_assets: ^1.0.0" to clipboard
lb_assets: ^1.0.0 copied to clipboard

Published 5 months ago • verified publisherlogbot.cloud• Latest: 1.3.0
[unknown platforms]
→

Metadata

Logbot assets service to manage assets (plants, groups, devices, gateways, gateway models, device models, device models metrics, licenses, manufacturers, ... etc.)

More...

lb-assets #

Getting started #

To make it easy for you to get started with GitLab, here's a list of recommended next steps.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? Use the template at the bottom!

Add your files #

cd existing_repo
git remote add origin https://git.logbotiot.cloud/logbot/mobile-apps/flutter-sdk/packages/lb-assets.git
git branch -M main
git push -uf origin main

Integrate with your tools #

Collaborate with your team #

Class Method HTTP request Description
DeviceModelMetricItemsApi gaDeviceModelMetricItemsIdPost POST /ga/device-model-metric-items/{id} Create a new device model metric item
DeviceModelMetricItemsApi gaDeviceModelMetricItemsIdPropIdDelete DELETE /ga/device-model-metric-items/{id}/{propId} Delete a device model metric item by ID
DeviceModelMetricItemsApi gaDeviceModelMetricItemsReplaceAllMetricsIdPost POST /ga/device-model-metric-items/replace-all-metrics/{id} Create a new device model metric item
DeviceModelsApi gaDeviceModelsGet GET /ga/device-models Retrieve a list of device models
DeviceModelsApi gaDeviceModelsIdDelete DELETE /ga/device-models/{id} Delete a device model by ID
DeviceModelsApi gaDeviceModelsIdGet GET /ga/device-models/{id} Retrieve a specific device model by ID
DeviceModelsApi gaDeviceModelsIdPut PUT /ga/device-models/{id} Update an existing device model by ID
DeviceModelsApi gaDeviceModelsPost POST /ga/device-models Create a new device model
DevicesApi gaDevicesGet GET /ga/devices List all devices
DevicesApi gaDevicesIdDelete DELETE /ga/devices/{id} Delete device by ID
DevicesApi gaDevicesIdGet GET /ga/devices/{id} Get a single device
DevicesApi gaDevicesIdPut PUT /ga/devices/{id} Update device by ID
DevicesApi gaDevicesPost POST /ga/devices Create a device
GatewayModelsApi gaGatewayModelsGet GET /ga/gateway-models Retrieve a list of gateway models
GatewayModelsApi gaGatewayModelsIdDelete DELETE /ga/gateway-models/{id} Delete a gateway model by ID
GatewayModelsApi gaGatewayModelsIdGet GET /ga/gateway-models/{id} Retrieve a specific gateway model by ID
GatewayModelsApi gaGatewayModelsIdPut PUT /ga/gateway-models/{id} Update an existing gateway model by ID
GatewayModelsApi gaGatewayModelsPost POST /ga/gateway-models Create a new gateway model
GatewaysApi gaGatewaysAssignLicenseIdPut PUT /ga/gateways/assignLicense/{id} Assign a license to a gateway
GatewaysApi gaGatewaysDisconnectIdPut PUT /ga/gateways/disconnect/{id} Disconnect a license from a gateway
GatewaysApi gaGatewaysGet GET /ga/gateways Get all gateways
GatewaysApi gaGatewaysIdDelete DELETE /ga/gateways/{id} Delete a gateway by ID
GatewaysApi gaGatewaysIdGet GET /ga/gateways/{id} Get a gateway by ID
GatewaysApi gaGatewaysIdPut PUT /ga/gateways/{id} Update a gateway by ID
GatewaysApi gaGatewaysPost POST /ga/gateways Create a new gateway
GroupsApi gaGroupIdGet GET /ga/group/{id} Get a group by ID
GroupsApi gaGroupsGet GET /ga/groups Find groups
LicensesApi gaLicenseIdGet GET /ga/license/{id} Retrieve a specific license by ID
LicensesApi gaLicenseResetLicenseIdGet GET /ga/license/reset-license/{id} Reset a license
LicensesApi gaLicenseRetrieveWithTokenPost POST /ga/license/retrieve-with-token Retrieve a license by token
LicensesApi gaLicensesGet GET /ga/licenses Retrieve a list of licenses
ManufacturersApi gaManufacturersGet GET /ga/manufacturers Retrieve a list of manufacturers
ManufacturersApi gaManufacturersIdDelete DELETE /ga/manufacturers/{id} Delete a manufacturer by ID
ManufacturersApi gaManufacturersIdGet GET /ga/manufacturers/{id} Retrieve a specific manufacturer by ID
ManufacturersApi gaManufacturersIdPut PUT /ga/manufacturers/{id} Update an existing manufacturer by ID
ManufacturersApi gaManufacturersPost POST /ga/manufacturers Create a new manufacturer
PlantsApi gaPlantsGet GET /ga/plants Get all plants
PlantsApi gaPlantsIdDelete DELETE /ga/plants/{id} Delete a plant
PlantsApi gaPlantsIdGet GET /ga/plants/{id} Get a specific plant by ID
PlantsApi gaPlantsIdPut PUT /ga/plants/{id} Update a plant
PlantsApi gaPlantsPost POST /ga/plants Create a plant
SupportedGatewaysApi gaSupportedGatewayIdDelete DELETE /ga/supported-gateway/{id} Delete a supported gateway by ID
SupportedGatewaysApi gaSupportedGatewayIdGet GET /ga/supported-gateway/{id} Retrieve a specific supported gateway by ID
SupportedGatewaysApi gaSupportedGatewayIdPut PUT /ga/supported-gateway/{id} Update an existing supported gateway by ID
SupportedGatewaysApi gaSupportedGatewayPost POST /ga/supported-gateway Create a new supported gateway
SupportedGatewaysApi gaSupportedGatewaysGet GET /ga/supported-gateways Retrieve a list of supported gateways
AssetsTransformsApi gaAssetsTransformsGet GET /ga/AssetsTransforms Retrieve a list of AssetsTransforms
AssetsTransformsApi gaAssetsTransformsIdDelete DELETE /ga/AssetsTransforms/{id} Delete a AssetsTransform by ID
AssetsTransformsApi gaAssetsTransformsIdGet GET /ga/AssetsTransforms/{id} Retrieve a specific AssetsTransform by ID
AssetsTransformsApi gaAssetsTransformsIdPut PUT /ga/AssetsTransforms/{id} Update an existing AssetsTransform by ID
AssetsTransformsApi gaAssetsTransformsPost POST /ga/AssetsTransforms Create a new AssetsTransform

35506e9 (Finishup first version of lb_assets)

Test and Deploy #

Use the built-in continuous integration in GitLab.

  • AccessLevel
  • Device
  • DeviceModel
  • DeviceModelMetricItemRequest
  • DeviceModelMetricItemResponse
  • DeviceModelRequestBodyData
  • DeviceRequestBodyData
  • RequestConnectDisconnectBody
  • RequestConnectDisconnectBodyData
  • Error
  • DeviceModelRequestBody
  • DeviceRequestBodyData
  • GatewayModelsRequestBody
  • GatewayAssignLicenseRequestBody
  • GatewayAssignLicenseRequestBodyData
  • GatewayDisconnectLicenseRequestBody
  • GatewayDisconnectLicenseRequestBodyData
  • GaGatewaysPostRequest
  • GaLicenseRetrieveWithTokenPostRequest
  • ManufacturersRequestBody
  • PlantPostRequestBody
  • AssetsTransformsRequestBody
  • Gateway
  • GatewayModel
  • GatewayModelRequestBodyData
  • GatewayRequestInput
  • GroupInfo
  • GroupPlant
  • LicenseGateway
  • LicenseRequestAssignBody
  • LicenseRequestBodyItem
  • LicenseRequestDisconnectBody
  • LicenseRequestInput
  • LicenseRequestInputGateway
  • LicenseRequestInputGatewayConnectInner
  • LicenseResponse
  • LogbotLink
  • LogbotLinkRequestBody
  • Manufacturer
  • ManufacturerRequestBodyData
  • MetricCategory
  • AssetsMetricModbusRTU
  • AssetsMetricModbusRTUResponse
  • AssetsMetricModbusTCP
  • AssetsMetricModbusTCPRequestBody
  • AssetsMetricModbusTCPResponse
  • AssetsMetricOPCUA
  • AssetsMetricOPCUARequestBody
  • AssetsMetricOPCUAResponse
  • MetricPermission
  • AssetsMetricS7
  • AssetsMetricS7RequestBody
  • AssetsMetricS7Response
  • MetricStaticTag
  • MetricTags
  • ModbusRTURequestBody
  • Plant
  • PlantRequestBodyData
  • AssetsProtocolEnum
  • RetPolicy
  • SpecialUuid
  • SpecialUuidRequestBody
  • SupportedGateway
  • SupportedGatewayRequestBody
  • AssetsTransform
  • AssetsTransformsRequestBodyData
  • Unit

35506e9 (Finishup first version of lb_assets)

Editing this README #

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to makeareadme.com for this template.

Suggestions for a good README #

Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

Name #

Choose a self-explaining name for your project.

Description #

Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

Badges #

On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

Visuals #

Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

Installation #

Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

Usage #

Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

Support #

Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

Roadmap #

If you have ideas for releases in the future, it is a good idea to list them in the README.

Contributing #

State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

Authors and acknowledgment #

Show your appreciation to those who have contributed to the project.

License #

For open source projects, say how it is licensed.

Project status #

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

lb_assets #

API documentation including GA plugin

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://your-website.com

Requirements #

Dart 2.12 or later

Installation & Usage #

Github #

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  lb_assets:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local #

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  lb_assets:
    path: /path/to/lb_assets

Tests #

TODO

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:lb_assets/api.dart';

// TODO Configure HTTP Bearer authorization: bearerAuth
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken(yourTokenGeneratorFunction);

final api_instance = DeviceModelMetricItemsApi();
final xUserId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final xOrgId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final xAuthGid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Path param: id
final deviceModelMetricItemRequest = DeviceModelMetricItemRequest(); // DeviceModelMetricItemRequest | 

try {
    final result = api_instance.gaDeviceModelMetricItemsIdPost(xUserId, xOrgId, xAuthGid, id, deviceModelMetricItemRequest);
    print(result);
} catch (e) {
    print('Exception when calling DeviceModelMetricItemsApi->gaDeviceModelMetricItemsIdPost: $e\n');
}

Documentation for API Endpoints #

All URIs are relative to http://localhost:1337/api

Class Method HTTP request Description
DeviceModelMetricItemsApi gaDeviceModelMetricItemsIdPost POST /ga/device-model-metric-items/{id} Create a new device model metric item
DeviceModelMetricItemsApi gaDeviceModelMetricItemsIdPropIdDelete DELETE /ga/device-model-metric-items/{id}/{propId} Delete a device model metric item by ID
DeviceModelMetricItemsApi gaDeviceModelMetricItemsReplaceAllMetricsIdPost POST /ga/device-model-metric-items/replace-all-metrics/{id} Create a new device model metric item
DeviceModelsApi gaDeviceModelsGet GET /ga/device-models Retrieve a list of device models
DeviceModelsApi gaDeviceModelsIdDelete DELETE /ga/device-models/{id} Delete a device model by ID
DeviceModelsApi gaDeviceModelsIdGet GET /ga/device-models/{id} Retrieve a specific device model by ID
DeviceModelsApi gaDeviceModelsIdPut PUT /ga/device-models/{id} Update an existing device model by ID
DeviceModelsApi gaDeviceModelsPost POST /ga/device-models Create a new device model
DevicesApi gaDevicesGet GET /ga/devices List all devices
DevicesApi gaDevicesIdDelete DELETE /ga/devices/{id} Delete device by ID
DevicesApi gaDevicesIdGet GET /ga/devices/{id} Get a single device
DevicesApi gaDevicesIdPut PUT /ga/devices/{id} Update device by ID
DevicesApi gaDevicesPost POST /ga/devices Create a device
GatewayModelsApi gaGatewayModelsGet GET /ga/gateway-models Retrieve a list of gateway models
GatewayModelsApi gaGatewayModelsIdDelete DELETE /ga/gateway-models/{id} Delete a gateway model by ID
GatewayModelsApi gaGatewayModelsIdGet GET /ga/gateway-models/{id} Retrieve a specific gateway model by ID
GatewayModelsApi gaGatewayModelsIdPut PUT /ga/gateway-models/{id} Update an existing gateway model by ID
GatewayModelsApi gaGatewayModelsPost POST /ga/gateway-models Create a new gateway model
GatewaysApi gaGatewaysAssignLicenseIdPut PUT /ga/gateways/assignLicense/{id} Assign a license to a gateway
GatewaysApi gaGatewaysDisconnectIdPut PUT /ga/gateways/disconnect/{id} Disconnect a license from a gateway
GatewaysApi gaGatewaysGet GET /ga/gateways Get all gateways
GatewaysApi gaGatewaysIdDelete DELETE /ga/gateways/{id} Delete a gateway by ID
GatewaysApi gaGatewaysIdGet GET /ga/gateways/{id} Get a gateway by ID
GatewaysApi gaGatewaysIdPut PUT /ga/gateways/{id} Update a gateway by ID
GatewaysApi gaGatewaysPost POST /ga/gateways Create a new gateway
GroupsApi gaGroupIdGet GET /ga/group/{id} Get a group by ID
GroupsApi gaGroupsGet GET /ga/groups Find groups
LicensesApi gaLicenseIdGet GET /ga/license/{id} Retrieve a specific license by ID
LicensesApi gaLicenseResetLicenseIdGet GET /ga/license/reset-license/{id} Reset a license
LicensesApi gaLicenseRetrieveWithTokenPost POST /ga/license/retrieve-with-token Retrieve a license by token
LicensesApi gaLicensesGet GET /ga/licenses Retrieve a list of licenses
ManufacturersApi gaManufacturersGet GET /ga/manufacturers Retrieve a list of manufacturers
ManufacturersApi gaManufacturersIdDelete DELETE /ga/manufacturers/{id} Delete a manufacturer by ID
ManufacturersApi gaManufacturersIdGet GET /ga/manufacturers/{id} Retrieve a specific manufacturer by ID
ManufacturersApi gaManufacturersIdPut PUT /ga/manufacturers/{id} Update an existing manufacturer by ID
ManufacturersApi gaManufacturersPost POST /ga/manufacturers Create a new manufacturer
PlantsApi gaPlantsGet GET /ga/plants Get all plants
PlantsApi gaPlantsIdDelete DELETE /ga/plants/{id} Delete a plant
PlantsApi gaPlantsIdGet GET /ga/plants/{id} Get a specific plant by ID
PlantsApi gaPlantsIdPut PUT /ga/plants/{id} Update a plant
PlantsApi gaPlantsPost POST /ga/plants Create a plant
SupportedGatewaysApi gaSupportedGatewayIdDelete DELETE /ga/supported-gateway/{id} Delete a supported gateway by ID
SupportedGatewaysApi gaSupportedGatewayIdGet GET /ga/supported-gateway/{id} Retrieve a specific supported gateway by ID
SupportedGatewaysApi gaSupportedGatewayIdPut PUT /ga/supported-gateway/{id} Update an existing supported gateway by ID
SupportedGatewaysApi gaSupportedGatewayPost POST /ga/supported-gateway Create a new supported gateway
SupportedGatewaysApi gaSupportedGatewaysGet GET /ga/supported-gateways Retrieve a list of supported gateways
AssetsTransformsApi gaAssetsTransformsGet GET /ga/AssetsTransforms Retrieve a list of AssetsTransforms
AssetsTransformsApi gaAssetsTransformsIdDelete DELETE /ga/AssetsTransforms/{id} Delete a AssetsTransform by ID
AssetsTransformsApi gaAssetsTransformsIdGet GET /ga/AssetsTransforms/{id} Retrieve a specific AssetsTransform by ID
AssetsTransformsApi gaAssetsTransformsIdPut PUT /ga/AssetsTransforms/{id} Update an existing AssetsTransform by ID
AssetsTransformsApi gaAssetsTransformsPost POST /ga/AssetsTransforms Create a new AssetsTransform

Documentation For Models #

  • AccessLevel
  • Device
  • DeviceModel
  • DeviceModelMetricItemRequest
  • DeviceModelMetricItemResponse
  • DeviceModelRequestBodyData
  • DeviceRequestBodyData
  • RequestConnectDisconnectBody
  • RequestConnectDisconnectBodyData
  • Error
  • DeviceModelRequestBody
  • DeviceRequestBodyData
  • GatewayModelsRequestBody
  • GatewayAssignLicenseRequestBody
  • GatewayAssignLicenseRequestBodyData
  • GatewayDisconnectLicenseRequestBody
  • GatewayDisconnectLicenseRequestBodyData
  • GaGatewaysPostRequest
  • GaLicenseRetrieveWithTokenPostRequest
  • ManufacturersRequestBody
  • PlantPostRequestBody
  • AssetsTransformsRequestBody
  • Gateway
  • GatewayModel
  • GatewayModelRequestBodyData
  • GatewayRequestInput
  • AssetsGroup
  • PlantBasic
  • LicenseGateway
  • LicenseRequestAssignBody
  • LicenseRequestBodyItem
  • LicenseRequestDisconnectBody
  • LicenseRequestInput
  • LicenseRequestInputGateway
  • LicenseRequestInputGatewayConnectInner
  • LicenseResponse
  • LogbotLink
  • LogbotLinkRequestBody
  • Manufacturer
  • ManufacturerRequestBodyData
  • MetricCategory
  • AssetsMetricModbusRTU
  • AssetsMetricModbusRTUResponse
  • AssetsMetricModbusTCP
  • AssetsMetricModbusTCPRequestBody
  • AssetsMetricModbusTCPResponse
  • AssetsMetricOPCUA
  • AssetsMetricOPCUARequestBody
  • AssetsMetricOPCUAResponse
  • MetricPermission
  • AssetsMetricS7
  • AssetsMetricS7RequestBody
  • AssetsMetricS7Response
  • MetricStaticTag
  • MetricTags
  • ModbusRTURequestBody
  • Plant
  • PlantRequestBodyData
  • AssetsProtocolEnum
  • RetPolicy
  • SpecialUuid
  • SpecialUuidRequestBody
  • SupportedGateway
  • SupportedGatewayRequestBody
  • AssetsTransform
  • AssetsTransformsRequestBodyData
  • Unit

Documentation For Authorization #

Authentication schemes defined for the API:

bearerAuth #

  • Type: HTTP Bearer authentication

Author #

team@example.com

← Metadata

0
likes
0
points
281
downloads

Documentation

Documentation

Publisher

verified publisherlogbot.cloud

Weekly Downloads

Metadata

Logbot assets service to manage assets (plants, groups, devices, gateways, gateway models, device models, device models metrics, licenses, manufacturers, ... etc.)

Homepage

License

unknown (license)

Dependencies

collection, http, intl, lb_auth, lb_commons, meta

More

Packages that depend on lb_assets

Back