Skip to content

Commit 58e3da2

Browse files
committed
update docs
1 parent a2685ea commit 58e3da2

1 file changed

Lines changed: 11 additions & 22 deletions

File tree

docs/tbfh.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,52 +15,41 @@ def __init__(self, buffer)
1515
Initialize self. See help(type(self)) for accurate signature.
1616

1717

18-
### get\_app\_size
18+
### get\_app\_name
1919
```py
2020

21-
def get_app_size(self)
21+
def get_app_name(self)
2222

2323
```
2424

2525

2626

27-
Get the total size the app takes in bytes in the flash of the chip.
28-
29-
30-
### get\_binary
31-
```py
32-
33-
def get_binary(self)
34-
35-
```
27+
Return the package name if it was encoded in the header, otherwise
28+
return a tuple of (package_name_offset, package_name_size).
3629

3730

38-
39-
Get the TBF header in a bytes array.
40-
41-
42-
### get\_name\_length
31+
### get\_app\_size
4332
```py
4433

45-
def get_name_length(self)
34+
def get_app_size(self)
4635

4736
```
4837

4938

5039

51-
Get the number of bytes for the application name.
40+
Get the total size the app takes in bytes in the flash of the chip.
5241

5342

54-
### get\_name\_offset
43+
### get\_binary
5544
```py
5645

57-
def get_name_offset(self)
46+
def get_binary(self)
5847

5948
```
6049

6150

6251

63-
Get the offset in the application binary where the application name is.
52+
Get the TBF header in a bytes array.
6453

6554

6655
### is\_enabled
@@ -130,7 +119,7 @@ Return str(self).
130119
### \_checksum
131120
```py
132121

133-
def _checksum(self)
122+
def _checksum(self, buffer)
134123

135124
```
136125

0 commit comments

Comments
 (0)