Skip to content

Commit 6bd80d3

Browse files
authored
Update eeprom.md - add links to UHB-IF wiki page
1 parent da124bf commit 6bd80d3

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/technical-reference/eeprom.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ This document is a work in progress. More details will be added as they become a
66
If you want your eeprom-equipped hexpansion to do something automatically, you need to write some data to the eeprom. The data consists of a header which contains hexpansion metadata and a littlefs file system which contains your application and data. The minimal application consists of a file called `app.py` that contains your code.
77

88
We will look for eeproms on the following i2c addresses:
9-
- 0x50
109
- 0x57
10+
- 0x50
1111

1212
The header is 32 bytes long and contains the following values:
1313

@@ -25,7 +25,7 @@ The header is 32 bytes long and contains the following values:
2525
- 4 bytes total size (total filesystem size in bytes)
2626
- VID/PID (offset 16, length 4)
2727
- 2 bytes VID
28-
- This is a Vendor ID. To obtain a Vendor ID, contact the Unnecessary Hexpansion Bureaucracy Implementers Forum (UHB-IF) at (location to be disclosed). If you don't want to do that, use vendor id f055.
28+
- This is a Vendor ID. Vendor IDs are assigned by the Unnecessary Hexpansion Bureaucracy Implementers Forum ([UHB-IF](https://badge.emfcamp.org/wiki/UHB-IF)) To obtain a Vendor ID, contact the UHB-IF at (location to be disclosed). If you don't want to do that, use a vendor ID from [here](https://badge.emfcamp.org/wiki/UHB-IF/Uncontrolled_IDs).
2929
- 2 bytes PID
3030
- This is a Product ID. If you have a Vendor ID, you can choose your own Product ID. If you are using the free-for-all Vendor ID, you will have to coordinate number assignments with other users on a wiki page (to be disclosed). Each hexpansion design with an eeprom needs a unique VID/PID combination.
3131
- Unique ID (offset 20, length 2)
@@ -43,15 +43,15 @@ The header is 32 bytes long and contains the following values:
4343

4444
```python
4545

46-
def calc_checksum(header): #header assumed to be of type bytes
47-
value=0x55
48-
for b in header[1:]:
49-
value= value ^ b
50-
return value
46+
def calc_checksum(header): #header assumed to be of type bytes
47+
value=0x55
48+
for b in header[1:]:
49+
value= value ^ b
50+
return value
5151

52-
header_w_checksum = header+bytes([calc_checksum(header)]) #to generate a checksum
52+
header_w_checksum = header+bytes([calc_checksum(header)]) #to generate a checksum
5353

54-
calc_checksum(header_w_checksum) # should return 0 if checksum is correct
54+
calc_checksum(header_w_checksum) # should return 0 if checksum is correct
5555

5656
```
5757

0 commit comments

Comments
 (0)