davidstalmarck commited on
Commit
020ea47
·
verified ·
1 Parent(s): 586c33d

Dataset card: pip install atech for firmware and drivers, atech.dev for the platform

Browse files
Files changed (1) hide show
  1. README.md +21 -5
README.md CHANGED
@@ -15,8 +15,22 @@ tags:
15
  # Atech SimReady modules and boards
16
 
17
  3-D simulation assets for every module in the [Atech SDK](https://pypi.org/project/atech/)
18
- catalog and for the 8-, 10- and 14-port boards. Each top-level folder is one
19
- SimReady asset package, in three formats:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
20
 
21
  ```
22
  atech_<asset>/
@@ -29,10 +43,12 @@ atech_<asset>/
29
  ```
30
 
31
  Asset names are `atech_<module id>` (e.g. `atech_distance_sensor`) and
32
- `atech_board_<board id>` (e.g. `atech_board_14port`).
 
33
 
34
- Generated with `atech sim-assets --all --board 8port,10port,14port --fetch`
35
- (`pip install "atech[sim]"`), then repackaged one folder per asset. The thumbnails
 
36
  are MuJoCo renders of the MJCF, so they show the CAD's flat material colours, not
37
  the USD's PBR shading or the display's screen texture.
38
 
 
15
  # Atech SimReady modules and boards
16
 
17
  3-D simulation assets for every module in the [Atech SDK](https://pypi.org/project/atech/)
18
+ catalog and for the 8-, 10- and 14-port boards.
19
+
20
+ ## Build with the real hardware
21
+
22
+ - **Firmware and drivers: the `atech` Python library.** `pip install atech` gives you
23
+ the module catalog, Atech's module drivers, and the commands that turn a small
24
+ `project.yaml` into firmware, build it, flash the board and talk to it from your
25
+ laptop (`atech new`, `atech build`, `atech upload`, `atech monitor`). It can also
26
+ run that firmware on an emulated board (`atech emulate`) and export these assets
27
+ (`atech sim-assets`). Source: [github.com/atechdotdev/python-sdk](https://github.com/atechdotdev/python-sdk).
28
+ - **Building on the Atech platform: [atech.dev](https://atech.dev).** The boards and
29
+ modules these assets model, and the platform to build projects with them.
30
+
31
+ ## Layout
32
+
33
+ Each top-level folder is one SimReady asset package, in three formats:
34
 
35
  ```
36
  atech_<asset>/
 
43
  ```
44
 
45
  Asset names are `atech_<module id>` (e.g. `atech_distance_sensor`) and
46
+ `atech_board_<board id>` (e.g. `atech_board_14port`); the robot-arm module is
47
+ `atech_robot_arm_integrator`, its product name.
48
 
49
+ Generated with `atech sim-assets --all --board 8port,10port,14port`
50
+ (`pip install "atech[sim]"`) on the SDK's development version, then repackaged one
51
+ folder per asset. The thumbnails
52
  are MuJoCo renders of the MJCF, so they show the CAD's flat material colours, not
53
  the USD's PBR shading or the display's screen texture.
54