# i40-aas-objects

> Provide a set of tools to realize the Asset Administration Shell for Industrie 4.0.

Latest version **0.3.6** (published 2020-06-10) · SEE LICENSE IN LICENSE license · 0 weekly downloads

## Install

```sh
npm install i40-aas-objects
pnpm add i40-aas-objects
yarn add i40-aas-objects
bun add i40-aas-objects
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.6 |
| Published | 2020-06-10 |
| First published | 2019-11-05 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 1019.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Maintainers | manu3756 |

## Links

- npm: https://www.npmjs.com/package/i40-aas-objects
- Repository: https://github.com/SAP/i40-aas-objects
- Homepage: https://github.com/SAP/i40-aas-objects#readme
- Issues: https://github.com/SAP/i40-aas-objects/issues
- npm.io page: https://npm.io/package/i40-aas-objects

## Dependencies (2)

- [jsonschema](https://npm.io/package/jsonschema.md) ^1.2.4
- [mime-types](https://npm.io/package/mime-types.md) ^2.1.25

## Recent versions

- 0.3.6 (latest) — 2020-06-10
- 0.2.6 — 2020-01-30
- 0.2.5 — 2020-01-27
- 0.2.4 — 2020-01-27
- 0.2.3 — 2020-01-27
- 0.2.2 — 2020-01-27
- 0.2.1 — 2020-01-23
- 0.2.0 — 2020-01-23
- 0.0.3-alpha — 2019-12-16
- 0.0.2-alpha — 2019-11-05
- 0.0.1-alpha — 2019-11-05

## README

# i40-aas-objects

Provide a set of tools to realize the Asset Administration Shell for Industrie 4.0.

[![Build Status](https://travis-ci.com/SAP/i40-aas-objects.svg?branch=master)](https://travis-ci.com/SAP/i40-aas-objects)

---

#### Contents:

-   [i40-aas-objects](#i40-aas-objects) - [Contents:](#contents)
    -   [Description](#description)
    -   [Requirements](#requirements)
    -   [Download and Installation](#download-and-installation)
        -   [1. Create an empty Node.js project](#1-create-an-empty-nodejs-project)
        -   [2. Prepare the TypeScript project](#2-prepare-the-typescript-project)
        -   [3. Add i40-aas-objects dependency in your package.json](#3-add-i40-aas-objects-dependency-in-your-packagejson)
        -   [4. Use i40-aas-objects](#4-use-i40-aas-objects)
    -   [Configuration [Optional]](#configuration-optional)
    -   [Limitations [Optional]](#limitations-optional)
    -   [Known Issues](#known-issues)
    -   [How to obtain support](#how-to-obtain-support)
    -   [Contributing](#contributing)
    -   [Upcoming changes](#upcoming-changes)
    -   [License](#license)

## Description

<!--- Describe your project, why it exists, what it should provide to the user, and what differentiates it from any other project available. --->

_i40-aas-objects_ is a typescript implementation of the specification ["Details of the AssetAdministrationShell"](https://www.plattform-i40.de/PI40/Redaktion/EN/Downloads/Publikation/2018-details-of-the-asset-administration-shell.html) part 1 version 2.0.1.

It implements all required classes to build an AAS-JSON-file. It is also possible to use it in the browser as it is JavaScript.

## Requirements

<!--- Requirements, hardware and software, that are used with your project. --->

<!--- Any external requirements must be hyperlinked to the site where that software, or that documentation, can be found. --->

You need to download and install [Node.js](https://nodejs.org/en/) and its packagemanager NPM.

Enter `node --version` and `npm --version` in your command line to test your installation.
You should see:

```
$ node --version
// min version: v8.12.0

$ npm --version
// min version: 6.4.1
```

Download and install the [TypeScriptCompiler (tsc)](https://www.npmjs.com/package/typescript).

```
$ npm install -g typescript
```

Check your installation with `tsc --version`.
You should see:

```
$ tsc --version
// min version: 3.5.3
```

## Download and Installation

<!--- Describe, in detail, how the project should be downloaded and installed. --->

<!--- Note: This section is the most likely to fail the review cycle. Please review carefully. --->

Import _i40-aas-objects_ as a dependency in your `package.json` file of your Node.js or TypeScript project.

### 1. Create an empty Node.js project

```
$ mkdir myaas
$ cd myaas
$ npm init
```

### 2. Prepare the TypeScript project

Create a `tsconfig.json` file in the root of the project directory and paste in the following snippet:

```
{
  "compilerOptions": {
    "target": "es6",
    "module": "commonjs",
    "outDir": "dist",
    "sourceMap": true,
    "resolveJsonModule": true,
    "esModuleInterop": true,
    "strict": true,
    "declaration": true
  },
  "include": ["src/**/*.ts", "index.ts"],
  "exclude": ["node_modules"]
}

```

### 3. Add i40-aas-objects dependency in your package.json

Let it be added by the package manager:

```
$ npm i --save i40-aas-objects
OR
$ npm i --save git://github.com/SAP/i40-aas-objects.git
```

Or add it manually to your `package.json`. (**NOTE**: You need to run `npm i` after you have edited your `package.json`.)

```
{
  "name": "testaas",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies":{
      "i40-aas-objects": "^0.2.0",
      ...
  },
  "author": "",
  "license": "SEE LICENSE IN LICENSE"
}
```

### 4. Use i40-aas-objects

[DOCS](https://i40-aas-objects-docs.cfapps.eu10.hana.ondemand.com/)

```typescript
import {
    AssetAdministrationShellEnv,
    Asset,
    AssetAdministrationShell,
    Submodel,
    IdTypeEnum,
    Property,
    AnyAtomicTypeEnum,
    Reference,
    KeyElementsEnum,
} from 'i40-aas-objects';

var run = function() {
    /* Create a Submodel and add a new Property to it*/
    var myAssetIdentificationModel = Submodel.fromJSON({
        identification: { id: 'http://test.com/submodel/id/identification123', idType: IdTypeEnum.IRDI },
        idShort: 'identification123',
    }).addSubmodelElement(
        new Property(
            'ManufacturerName',
            AnyAtomicTypeEnum.string,
            'SAP SE',
            undefined,
            new Reference({
                keys: [
                    {
                        local: false,
                        type: KeyElementsEnum.GlobalReference,
                        idType: IdTypeEnum.IRDI,
                        value: '0173-1#02-AAO677#002',
                    },
                ],
            }),
        ),
    );
    /* Create an asset and add a reference to the previously created submodel as it assetIdentificationModel*/
    var myAsset = new Asset(
        { id: 'http://test.com/asset/123', idType: IdTypeEnum.IRDI },
        '123',
    ).setAssetIdentificationModel(myAssetIdentificationModel.getReference());

    /* Create an AAS and add a reference to the previously created asset as its asset*/
    var myAas = new AssetAdministrationShell(
        { id: 'http://test.com/aas/id/aas123', idType: IdTypeEnum.IRDI },
        'identification123',
    ).setAsset(myAsset.getReference());

    /* Create an environment and add all identifiables */
    var myNewAasEnv = new AssetAdministrationShellEnv()
        .addAssetAdministrationShell(myAas)
        .addAsset(myAsset)
        .addSubmodel(myAssetIdentificationModel);

    /* print the environment to the console */
    console.log(JSON.stringify(myNewAasEnv, null, 3));
};
run();
```

<!---
## Configuration [Optional]

*These options may not be part of the installation process, but help configure the source for specific uses.*

*This section may be omitted if there are no configuration options, or if all configuration is done and documented in the installation instructions.*

## Limitations [Optional]

*If your project has limitations that prevent it from working on certain hardware, or in certain software or configurations, please list those here.*

*If there are no known limitations, this section can be omitted.*
--->

## Known Issues

<!--- Please list all known issues, or bugs, here. Even if the project is provided "as-is" any known problems should be listed. --->

Please refer to the list of [issues](https://github.com/SAP/i40-aas-objects/issues) on GitHub.

## How to obtain support

<!--- This section should contain details on how the outside user can obtain support, ask questions, or post a bug report on your project. If your project is provided "as-is", with no expected changes or support, you must state that here. --->

Please use the [GitHub issue tracker](https://github.com/SAP/i40-aas-objects/issues) for any questions, bug reports, feature requests, etc.

## Contributing

<!--- Details on how external developers can contribute to your code should be posted here. You can also link to a dedicated CONTRIBUTING.md file. See further details here. --->

You are welcome to join us in our efforts to improve and increase the set of tools to realize the Asset Administration Shell for Industrie 4.0!

Simply check the [Contribution Guidelines](CONTRIBUTING.md).

## Upcoming changes

<!--- Details on any expected changes in later versions. If your project is released "as-is", or you know of no upcoming changes, this section can be omitted. --->

This project follows the specification ["Details of the AssetAdministrationShell"](https://www.plattform-i40.de/PI40/Redaktion/EN/Downloads/Publikation/2018-details-of-the-asset-administration-shell.html) part 1 version 1.0, which is work in progress. As the specification changes, so will this project.

For upcoming changes under development, please refer to the [Github issue board](https://github.com/SAP/i40-aas-objects/issues).

## License

Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the [LICENSE file](LICENSE).

Please note that Docker images can contain other software which may be licensed under different licenses. This License file is also included in the Docker image. For any usage of built Docker images please make sure to check the licenses of the artifacts contained in the images.

---
_Source: https://npm.io/package/i40-aas-objects · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._