Skip to content

Commit fdc2d34

Browse files
committed
Fix links in examples
1 parent c0336d8 commit fdc2d34

File tree

4 files changed

+18
-16
lines changed

4 files changed

+18
-16
lines changed

doc/examples/ev-charging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ the charging process.
382382
### End of Charging
383383

384384
Creating a _Signed Turn-Off Snapshot_ ends the charging process by turning of
385-
the contactor and recoding the snapshot data. Again, [Snapshot Creation]() gives
385+
the contactor and recoding the snapshot data. Again, [Snapshot Creation](snapshots.md#snapshot-creation) gives
386386
the details about this procedure.
387387

388388

@@ -453,7 +453,7 @@ the _Signed Turn-On Snapshot_ taken at the start of charging:
453453
difference can be one least significant digit larger than the value for
454454
_RCR_ (shown in the display).
455455
- Again, there is no active power
456-
([_W_](../../bauer_bsm/bsm/models/smdx_64901.xml#L185) = 0 Wh) since
456+
([_W_](../../bauer_bsm/bsm/models/smdx_64901.xml#L201) = 0 Wh) since
457457
power delivery got cut before recording the snapshot data
458458
- Time and counters
459459
- The response counter

doc/examples/modbus-interface.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ describes the interpretation of standard data types.
141141

142142
The BSM-WS36A provides several data as Binary Large Objects (BLOBs) - for
143143
example, its [public key](../../bauer_bsm/bsm/models/smdx_64900.xml#L31) and
144-
[snapshot signatures](../../bauer_bsm/bsm/models/smdx_64901.xml#L65).
144+
[snapshot signatures](../../bauer_bsm/bsm/models/smdx_64901.xml#L67).
145145

146146
SunSpec does not define a data representation for BLOBs and so a proprietary
147147
[bsm\_blob](../../bauer_bsm/bsm/models/smdx_64902.xml) or a similar arrangement
@@ -154,7 +154,7 @@ representation is used. Either by the specialized BLOB model
154154
- [_BB_](../../bauer_bsm/bsm/models/smdx_64902.xml#L49) the actual number of
155155
bytes
156156

157-
- [_B_](bauer_bsm/bsm/models/smdx_64902.xml#L53) a repeating block with a
157+
- [_B_](../../bauer_bsm/bsm/models/smdx_64902.xml#L53) a repeating block with a
158158
single register of this name forming the BLOB data area
159159

160160
See [Signed Snapshots](snapshots.md) for an example.

doc/examples/ocmf.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ model instance afterwards.
3737
## Snapshot Data in OCMF
3838

3939
The OCMF representation includes
40-
[_Meta1_](../../../../bauer_bsm/bsm/models/smdx_64901.xml#L31) as customer
40+
[_Meta1_](../../bauer_bsm/bsm/models/smdx_64901.xml#L31) as customer
4141
identification data which needs to be set appropriately. The other metadata
4242
fields are ignored and will not appear in OCMF output.
4343

@@ -206,17 +206,19 @@ uses an XML envelope.
206206
The XML envelope includes the OCMF data taken before starting and after
207207
terminating the charging process along with the public key used for signing.
208208
The format could be generated from a
209-
[template](../../bauer_bsm/bsm/client.py#L214) where the actual data gets
209+
[template](../../bauer_bsm/exporter/ocmf.py#L48) where the actual data gets
210210
inserted.
211211

212212

213213
### Generating OCMF XML
214214

215-
The [BSM Python support](../../bauer_bsm/bsm/client.py#L183) and the BSM Tool
216-
support the generation of OCMF XML data for _OCMF Signed Turn-On Snapshot_ and
217-
_OCMF Signed Turn-Off Snapshot_ when the corresponding snapshots have already
218-
been successfully created. To generate an OCMF XML envelope, invoke the BSM
219-
Tool as follows:
215+
The [BSM Python support](../../bauer_bsm/exporter/ocmf.py#L12) and the [BSM
216+
Tool](../../bauer_bsm/cli/bsmtool.py#L343) support the generation of OCMF XML
217+
data for the OCMF representation of a pair of already created snapshots (the
218+
switching snapshots _OCMF Signed Turn-On Snapshot_ and _OCMF Signed Turn-Off
219+
Snapshot_ or the non-switching _OCMF Signed Start Snapshot_ and _OCMF Signed
220+
End Snapshot_). To generate an OCMF XML envelope for the switching snapshots,
221+
invoke the BSM Tool as follows:
220222

221223
- Create _Signed Turn-On Snapshot_
222224
```

doc/examples/snapshots.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@ consumption without switching an external contactor:
4040
## Snapshot Creation
4141

4242
A snapshot gets created by the writing to its status data point
43-
[_St_](../../bauer_bsm/bsm/models/smdx_64901.xml#L115) and polling this data
43+
[_St_](../../bauer_bsm/bsm/models/smdx_64901.xml#L131) and polling this data
4444
point afterwards its value indicates either a successful update or a failure.
4545

4646
The procedure looks as follows:
4747

48-
1. Write [_UPDATING_](../../bauer_bsm/bsm/models/smdx_64901.xml#L12) (2) to
49-
[_St_](../../bauer_bsm/bsm/models/smdx_64901.xml#L115)
48+
1. Write [_UPDATING_](../../bauer_bsm/bsm/models/smdx_64901.xml#L14) (2) to
49+
[_St_](../../bauer_bsm/bsm/models/smdx_64901.xml#L131)
5050
2. Read the value of _St_ with a timeout of 15 seconds
5151
3. If _St_ returns _UPDATING_ (2), continue with step 2
5252
4. If _St_ returns _VALID_ (0), the snapshot data is ready to be read
@@ -241,10 +241,10 @@ $ bsmtool dump 40521 254
241241
A snapshot records three data points related to power and energy:
242242

243243
- The reference cumulative register
244-
[_RCR_](bauer_bsm/bsm/models/smdx_64901.xml#L185) which counts the energy
244+
[_RCR_](../../bauer_bsm/bsm/models/smdx_64901.xml#L185) which counts the energy
245245
consumption since it got reset during the creation of the last _Signed
246246
Turn-On Snapshot_
247-
- [_TotWhImp_](bauer_bsm/bsm/models/smdx_64901.xml#L193) counting the overall
247+
- [_TotWhImp_](../../bauer_bsm/bsm/models/smdx_64901.xml#L193) counting the overall
248248
energy consumption measured by the BSM-WS36A
249249
- And the actual real power consumption
250250
[_W_](../../bauer_bsm/bsm/models/smdx_64901.xml#L201)

0 commit comments

Comments
 (0)