https://github.com/eclipse-basyx/basyx-typescript-sdk
BaSyx TypeScript SDK for developing applications and components for the Asset Administration Shell (AAS)
https://github.com/eclipse-basyx/basyx-typescript-sdk
aas assetadministrationshell basyx client utils
Last synced: about 2 months ago
JSON representation
BaSyx TypeScript SDK for developing applications and components for the Asset Administration Shell (AAS)
- Host: GitHub
- URL: https://github.com/eclipse-basyx/basyx-typescript-sdk
- Owner: eclipse-basyx
- License: mit
- Created: 2025-01-16T08:22:58.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-04-14T20:33:57.000Z (about 2 months ago)
- Last Synced: 2025-04-14T21:36:04.538Z (about 2 months ago)
- Topics: aas, assetadministrationshell, basyx, client, utils
- Language: TypeScript
- Size: 1.36 MB
- Stars: 3
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README



# basyx-typescript-sdk
BaSyx TypeScript SDK for developing applications and components for the Asset Administration Shell (AAS)
## Features
Clients for the AAS API components:
- AAS Repository
- Submodel Repository (coming soon)
- Concept Description Repository (coming soon)
- AAS Registry (coming soon)
- Submodel Registry (coming soon)
- AAS Discovery Service (coming soon)
- AASX File Service (coming soon)Utility functions for working with AAS data:
- Coming soon## Installation
```bash
npm install basyx-typescript-sdk
# or
yarn add basyx-typescript-sdk
```> See https://www.npmjs.com/package/basyx-typescript-sdk
---
> [!IMPORTANT]
> Make sure to install `@aas-core-works/aas-core3.0-typescript` in your project:```bash
npm install @aas-core-works/aas-core3.0-typescript
# or
yarn add @aas-core-works/aas-core3.0-typescript
```## Usage
```typescript
import { AasRepositoryClient, Configuration } from 'basyx-typescript-sdk';async function getAllShells() {
const client = new AasRepositoryClient();
const configuration = new Configuration({
basePath: 'http://localhost:8081',
});try {
const response = await client.getAllAssetAdministrationShells({ configuration });
console.log('Asset Administration Shells fetched successfully:', response);
// You can now use the response as needed
} catch (error) {
console.error('Error fetching Asset Administration Shells:', error);
}
}getAllShells();
```