Skip to content

Commit 7ada85e

Browse files
libdriverlibdriver
committed
docs: add MISRA
1 parent 84ad27d commit 7ada85e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+873
-442
lines changed

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
[English](/README.md) | [ 简体中文](/README_zh-Hans.md) | [繁體中文](/README_zh-Hant.md)
1+
[English](/README.md) | [ 简体中文](/README_zh-Hans.md) | [繁體中文](/README_zh-Hant.md) | [日本語](/README_ja.md) | [Deutsch](/README_de.md) | [한국어](/README_ko.md)
22

33
<div align=center>
44
<img src="/doc/image/logo.png"/>
55
</div>
66

77
## LibDriver AT24CXX
88

9-
[![API](https://img.shields.io/badge/api-reference-blue)](https://www.libdriver.com/docs/at24cxx/index.html) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](/LICENSE)
9+
[![MISRA](https://img.shields.io/badge/misra-compliant-brightgreen.svg)](/misra/README.md) [![API](https://img.shields.io/badge/api-reference-blue.svg)](https://www.libdriver.com/docs/at24cxx/index.html) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](/LICENSE)
1010

1111
AT24CXX is the EEPROM of IIC bus launched by Microchip. It supports 1.7v-5.5v power supply range, IIC standard mode (100kHz), fast mode (400kHz) and high speed mode (1MHz).
1212

13-
LibDriver AT24CXX is the full function driver of AT24CXX launched by LibDriver. AT24CXX provides EEPROM write and read functions.
13+
LibDriver AT24CXX is the full function driver of AT24CXX launched by LibDriver. AT24CXX provides EEPROM write and read functions. LibDriver is MISRA compliant.
1414

1515
### Table of Contents
1616

‎README_de.md

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
[English](/README.md) | [ 简体中文](/README_zh-Hans.md) | [繁體中文](/README_zh-Hant.md) | [日本語](/README_ja.md) | [Deutsch](/README_de.md) | [한국어](/README_ko.md)
2+
3+
<div align=center>
4+
<img src="/doc/image/logo.png"/>
5+
</div>
6+
7+
## LibDriver AT24CXX
8+
[![MISRA](https://img.shields.io/badge/misra-compliant-brightgreen.svg)](/misra/README.md) [![API](https://img.shields.io/badge/api-reference-blue.svg)](https://www.libdriver.com/docs/at24cxx/index.html) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](/LICENSE)
9+
10+
AT24CXX ist das EEPROM des von Microchip eingeführten IIC-Busses. Es unterstützt einen Stromversorgungsbereich von 1,7 V bis 5,5 V, den IIC-Standardmodus (100 kHz), den Schnellmodus (400 kHz) und den Hochgeschwindigkeitsmodus (1 MHz).
11+
12+
LibDriver AT24CXX ist der Treiber mit vollem Funktionsumfang von AT24CXX, der von LibDriver gestartet wurde. AT24CXX bietet EEPROM-Schreib- und Lesefunktionen. LibDriver ist MISRA-konform.
13+
14+
### Inhaltsverzeichnis
15+
16+
- [Anweisung](#Anweisung)
17+
- [Installieren](#Installieren)
18+
- [Nutzung](#Nutzung)
19+
- [example basic](#example-basic)
20+
- [Dokument](#Dokument)
21+
- [Beitrag](#Beitrag)
22+
- [Lizenz](#Lizenz)
23+
- [Kontaktieren Sie uns](#Kontaktieren-Sie-uns)
24+
25+
### Anweisung
26+
27+
/src enthält LibDriver AT24CXX-Quelldateien.
28+
29+
/interface enthält die plattformunabhängige Vorlage LibDriver AT24CXX IIC。
30+
31+
/test enthält den Testcode des LibDriver AT24CXX-Treibers und dieser Code kann die erforderliche Funktion des Chips einfach testen。
32+
33+
/example enthält LibDriver AT24CXX-Beispielcode.
34+
35+
/doc enthält das LibDriver AT24CXX-Offlinedokument.
36+
37+
/Datenblatt enthält AT24CXX-Datenblatt。
38+
39+
/project enthält den allgemeinen Beispielcode für Linux- und MCU-Entwicklungsboards. Alle Projekte verwenden das Shell-Skript, um den Treiber zu debuggen, und die detaillierten Anweisungen finden Sie in der README.md jedes Projekts.
40+
41+
### Installieren
42+
43+
Verweisen Sie auf eine plattformunabhängige IIC-Schnittstellenvorlage und stellen Sie Ihren Plattform-IIC-Treiber fertig.
44+
45+
Fügen Sie /src, /interface und /example zu Ihrem Projekt hinzu.
46+
47+
### Nutzung
48+
49+
#### example basic
50+
51+
```C
52+
uint8_t res;
53+
uint8_t data;
54+
55+
res = at24cxx_basic_init(AT24C01, AT24CXX_ADDRESS_A000);
56+
if (res)
57+
{
58+
return 1;
59+
}
60+
61+
...
62+
63+
res = at24cxx_basic_read(0x00, (uint8_t *)&data, 1);
64+
if (res)
65+
{
66+
at24cxx_basic_deinit();
67+
68+
return 1;
69+
}
70+
else
71+
{
72+
at24cxx_interface_debug_print("at24cxx: 0x%02X.\n", data);
73+
}
74+
75+
...
76+
77+
res = at24cxx_basic_write(0x00, (uint8_t *)&data, 1);
78+
if (res)
79+
{
80+
at24cxx_basic_deinit();
81+
82+
return 1;
83+
}
84+
else
85+
{
86+
at24cxx_interface_debug_print("at24cxx: 0x%02X.\n", data);
87+
}
88+
89+
...
90+
91+
at24cxx_basic_deinit();
92+
93+
return 0;
94+
```
95+
96+
### Dokument
97+
98+
Online-Dokumente: https://www.libdriver.com/docs/at24cxx/index.html
99+
100+
Offline-Dokumente: /doc/html/index.html
101+
102+
### Beitrag
103+
104+
Bitte senden Sie eine E-Mail an lishifenging@outlook.com
105+
106+
### Lizenz
107+
108+
Urheberrechte © (c) 2015 - Gegenwart LibDriver Alle Rechte vorbehalten
109+
110+
111+
112+
Die MIT-Lizenz (MIT)
113+
114+
115+
116+
Hiermit wird jeder Person kostenlos die Erlaubnis erteilt, eine Kopie zu erhalten
117+
118+
dieser Software und zugehörigen Dokumentationsdateien (die „Software“) zu behandeln
119+
120+
in der Software ohne Einschränkung, einschließlich, aber nicht beschränkt auf die Rechte
121+
122+
zu verwenden, zu kopieren, zu modifizieren, zusammenzuführen, zu veröffentlichen, zu verteilen, unterzulizenzieren und/oder zu verkaufen
123+
124+
Kopien der Software und Personen, denen die Software gehört, zu gestatten
125+
126+
dazu eingerichtet werden, unter folgenden Bedingungen:
127+
128+
129+
130+
Der obige Urheberrechtshinweis und dieser Genehmigungshinweis müssen in allen enthalten sein
131+
132+
Kopien oder wesentliche Teile der Software.
133+
134+
135+
136+
DIE SOFTWARE WIRD "WIE BESEHEN" BEREITGESTELLT, OHNE JEGLICHE GEWÄHRLEISTUNG, AUSDRÜCKLICH ODER
137+
138+
STILLSCHWEIGEND, EINSCHLIESSLICH, ABER NICHT BESCHRÄNKT AUF DIE GEWÄHRLEISTUNG DER MARKTGÄNGIGKEIT,
139+
140+
EIGNUNG FÜR EINEN BESTIMMTEN ZWECK UND NICHTVERLETZUNG VON RECHTEN DRITTER. IN KEINEM FALL DARF DAS
141+
142+
AUTOREN ODER URHEBERRECHTSINHABER HAFTEN FÜR JEGLICHE ANSPRÜCHE, SCHÄDEN ODER ANDERE
143+
144+
HAFTUNG, OB AUS VERTRAG, DELIKT ODER ANDERWEITIG, ENTSTEHEND AUS,
145+
146+
AUS ODER IM ZUSAMMENHANG MIT DER SOFTWARE ODER DER VERWENDUNG ODER ANDEREN HANDLUNGEN MIT DER
147+
148+
SOFTWARE.
149+
150+
### Kontaktieren Sie uns
151+
152+
Bitte senden Sie eine E-Mail an lishifenging@outlook.com

‎README_ja.md

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
[English](/README.md) | [ 简体中文](/README_zh-Hans.md) | [繁體中文](/README_zh-Hant.md) | [日本語](/README_ja.md) | [Deutsch](/README_de.md) | [한국어](/README_ko.md)
2+
3+
<div align=center>
4+
<img src="/doc/image/logo.png"/>
5+
</div>
6+
7+
## LibDriver AT24CXX
8+
9+
[![MISRA](https://img.shields.io/badge/misra-compliant-brightgreen.svg)](/misra/README.md) [![API](https://img.shields.io/badge/api-reference-blue.svg)](https://www.libdriver.com/docs/at24cxx/index.html) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](/LICENSE)
10+
11+
AT24CXXは、Microchip社が発売したIICバスのEEPROMです。 1.7v〜5.5vの電源範囲、IIC標準モード（100kHz）、高速モード（400kHz）、高速モード（1MHz）をサポートします。
12+
13+
LibDriver AT24CXXは、LibDriverによって起動されたAT24CXXの全機能ドライバーです。 AT24CXXは、EEPROMの書き込みおよび読み取り機能を提供します。 LibDriverはMISRAに準拠しています。
14+
15+
### 目次
16+
17+
- [説明](#説明)
18+
- [インストール](#インストール)
19+
- [使用](#使用)
20+
- [example basic](#example-basic)
21+
- [ドキュメント](#ドキュメント)
22+
- [貢献](#貢献)
23+
- [著作権](#著作権)
24+
- [連絡して](#連絡して)
25+
26+
### 説明
27+
28+
/ srcディレクトリには、LibDriver AT24CXXのソースファイルが含まれています。
29+
30+
/ interfaceディレクトリには、LibDriver AT24CXX用のプラットフォームに依存しないIICバステンプレートが含まれています。
31+
32+
/ testディレクトリには、チップの必要な機能を簡単にテストできるLibDriver AT24CXXドライバーテストプログラムが含まれています。
33+
34+
/ exampleディレクトリには、LibDriver AT24CXXプログラミング例が含まれています。
35+
36+
/ docディレクトリには、LibDriver AT24CXXオフラインドキュメントが含まれています。
37+
38+
/ datasheetディレクトリには、AT24CXXデータシートが含まれています。
39+
40+
/ projectディレクトリには、一般的に使用されるLinuxおよびマイクロコントローラー開発ボードのプロジェクトサンプルが含まれています。 すべてのプロジェクトは、デバッグ方法としてシェルスクリプトを使用しています。詳細については、各プロジェクトのREADME.mdを参照してください。
41+
42+
### インストール
43+
44+
/ interfaceディレクトリにあるプラットフォームに依存しないIICバステンプレートを参照して、指定したプラットフォームのIICバスドライバを完成させます。
45+
46+
/ srcディレクトリ、/ interfaceディレクトリ、および/exampleディレクトリをプロジェクトに追加します。
47+
48+
### 使用
49+
50+
#### example basic
51+
52+
```C
53+
uint8_t res;
54+
uint8_t data;
55+
56+
res = at24cxx_basic_init(AT24C01, AT24CXX_ADDRESS_A000);
57+
if (res)
58+
{
59+
return 1;
60+
}
61+
62+
...
63+
64+
res = at24cxx_basic_read(0x00, (uint8_t *)&data, 1);
65+
if (res)
66+
{
67+
at24cxx_basic_deinit();
68+
69+
return 1;
70+
}
71+
else
72+
{
73+
at24cxx_interface_debug_print("at24cxx: 0x%02X.\n", data);
74+
}
75+
76+
...
77+
78+
res = at24cxx_basic_write(0x00, (uint8_t *)&data, 1);
79+
if (res)
80+
{
81+
at24cxx_basic_deinit();
82+
83+
return 1;
84+
}
85+
else
86+
{
87+
at24cxx_interface_debug_print("at24cxx: 0x%02X.\n", data);
88+
}
89+
90+
...
91+
92+
at24cxx_basic_deinit();
93+
94+
return 0;
95+
```
96+
97+
### ドキュメント
98+
99+
オンラインドキュメント: https://www.libdriver.com/docs/at24cxx/index.html
100+
101+
オフラインドキュメント: /doc/html/index.html
102+
103+
### 貢献
104+
105+
お問い合わせくださいlishifenging@outlook.com
106+
107+
### 著作権
108+
109+
著作権（c）2015-今 LibDriver 全著作権所有
110+
111+
MITライセンス（MIT）
112+
113+
このソフトウェアおよび関連するドキュメントファイル（「ソフトウェア」）のコピーを取得した人は、無制限の使用、複製、変更、組み込み、公開、配布、サブライセンスを含む、ソフトウェアを処分する権利を制限なく付与されます。ソフトウェアのライセンスおよび/またはコピーの販売、および上記のようにソフトウェアが配布された人の権利のサブライセンスは、次の条件に従うものとします。
114+
115+
上記の著作権表示およびこの許可通知は、このソフトウェアのすべてのコピーまたは実体に含まれるものとします。
116+
117+
このソフトウェアは「現状有姿」で提供され、商品性、特定目的への適合性、および非侵害の保証を含むがこれらに限定されない、明示または黙示を問わず、いかなる種類の保証もありません。 いかなる場合も、作者または著作権所有者は、契約、不法行為、またはその他の方法で、本ソフトウェアおよび本ソフトウェアの使用またはその他の廃棄に起因または関連して、請求、損害、またはその他の責任を負わないものとします。
118+
119+
### 連絡して
120+
121+
お問い合わせくださいlishifenging@outlook.com

0 commit comments

Comments
 (0)