Skip to content

Commit

Permalink
prepare for release
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-hillmann committed May 13, 2020
1 parent 62dd6ff commit 67f7b1c
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 26 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,14 +140,15 @@ Some years later, now in 2020, we think it is time for a new way of software dev
To avoid confusion, it is the best to continue with the release version numbering with the semantic scheme 'major'.'minor'.'build'. The first stable release of the open-source variant of the CANopen Stack is:
**V4.0.0** - working hard to get this done. When ready, the release will linked here.
**V4.0.0** - First open source release.
*Ideas for further development:*
- remove all pre-compiler configuration defines to allow a single library for multiple projects with different needs
- hardware independent collection of examples for demonstration purpose (exchange driver and re-compiler should be enought for usage on real target hardware)
- improve documentation of single test cases within the testsuite
- add the SDO client (rarely used, but nice to have)
Feel free to add issues with further ideas or needs!
# License
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/api/dictionary/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ articles:

---

This area describes the API functions of the object dictionary module. These functions are implemented within the source file: `co_dict.c/h`
This area describes the API functions of the object dictionary module. These functions are implemented within the source file: `co_dict.c/h`

<!--more-->

The class CO_DICT is defined within `co_dict.h` and is responsible for the object dictionary handling functions. The following data members are allocated in this class:
The class CO_DICT is defined within `co_dict.h` and is responsible for the object dictionary handling functions. The following data members are allocated in this class:

| Data Member | Type | Description |
| --- | --- | --- |
Expand All @@ -26,7 +26,7 @@ articles:
| Num | `uint16_t` | current number of objects in dictionary |
| Max | `uint16_t` | maximum number of objects in dictionary |

Note: The data within this structure must never be manipulated without the corresponding class member functions. This can lead to unpredictable behavior of the node.
Note: The data within this structure must never be manipulated without the corresponding class member functions. This can lead to unpredictable behavior of the node.

***Attention: The access with the member functions of this class to an object entry must be done with the correct width. There is no casting of the object entry values to the requested value types.***

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api/emergency/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ articles:
| Cnt[] | `uint8_t` | error register object entry bit counters |
| Err[] | `uint8_t` | individual emergency status storage |

Note: The data within this structure must never be manipulated without the corresponding class member functions. This can lead to unpredictable behavior of the node.
Note: The data within this structure must never be manipulated without the corresponding class member functions. This can lead to unpredictable behavior of the node.

</div>
2 changes: 1 addition & 1 deletion docs/docs/api/network/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ articles:
| Tmr | `int16_t` | heartpeat producer timer identifier |
| Allowed | `uint8_t` | encoding of allowed CAN messages |

Note: The data within this structure must never be manipulated without the corresponding class member functions. This can lead to unpredictable behavior of the node.
Note: The data within this structure must never be manipulated without the corresponding class member functions. This can lead to unpredictable behavior of the node.

</div>
12 changes: 0 additions & 12 deletions docs/docs/start/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@ aside:
toc: true
---

**Note: This project is not production ready!**

*I work hard (in my spare time) to transfer every aspect from internal management at Embedded Office to this open source repository. I expect the first public release in Q2/2020.*


## Getting the Source

All you need to do is copying all files to your local drive. There are several ways to do so:
Expand All @@ -24,8 +19,6 @@ Clone [canopen-stack](https://github.com/embedded-office/canopen-stack) from git
git clone https://github.com/embedded-office/canopen-stack.git
```

*This method is fine, if you want to get the latest changes in the repository*

### Download ZIP File

Download and unzip the file from repository [canopen-stack](https://github.com/embedded-office/canopen-stack):
Expand All @@ -34,14 +27,9 @@ Download and unzip the file from repository [canopen-stack](https://github.com/e
- Select `Download ZIP`
- Unzip the archive to your local drive

*This method is fine, if you want to get a released version*

### Fork Repository

Fork the github repository [canopen-stack](https://github.com/embedded-office/canopen-stack)

*This method is fine, if you want to contribute with your pull requests to the project*


## Cross-compile for Target

Expand Down
4 changes: 0 additions & 4 deletions docs/docs/start/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ aside:
toc: true
---

**Note: This project is not production ready!**

*I work hard (in my spare time) to transfer every aspect from internal management at Embedded Office to this open source repository. I expect the first public release in Q2/2020.*

## CANopen Clock

This quickstart tutorial describes in detail the steps to build a CANopen Clock.
Expand Down
4 changes: 0 additions & 4 deletions docs/docs/start/structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ aside:
toc: true
---

**Note: This project is not production ready!**

*I work hard (in my spare time) to transfer every aspect from internal management at Embedded Office to this open source repository. I expect the first public release in Q2/2020.*

## Layout of Repository

The following description explains the directories within this repository.
Expand Down

0 comments on commit 67f7b1c

Please sign in to comment.