NFC Charge Authorization

Requires the "nfc" feature.

warp1

nfc/seen_tags

The NFC tags most recently seen by the charger.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/nfc/seen_tags

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/nfc/seen_tags

[
  { "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE", "last_seen": 22724083 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "01:23:AB:3D", "last_seen": 10753 }
]

Index	Description
[0..7] object	A seen NFC tag Name Description tag_type int Type of the tag 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D last_seen int (ms) Time in milliseconds since the tag was last seen.
[8] object	The tag spoofed by nfc/inject_tag Name Description tag_type int Type of the tag 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D last_seen int (ms) Time in milliseconds since the tag was last seen.

nfc/inject_tag

Pretends that a tag was detected by the NFC reader. This can be used to start or stop a charging session for a specific user via the API. Analogous to the physical use of a tag, the charging session is alternately authorized or blocked with each API call. See nfc/inject_tag_start and nfc/inject_tag_stop for more precise control. The spoofed tag is always the last entry in nfc/seen_tags

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/nfc/inject_tag -d '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/nfc/inject_tag -m '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

Name	Description
tag_type int	Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4
tag_id string	ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

nfc/inject_tag_start

Pretends that a tag was detected by the NFC reader. The tag is only used to start a charging session. The spoofed tag is always the last entry in nfc/seen_tags

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/nfc/inject_tag_start -d '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/nfc/inject_tag_start -m '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

Name	Description
tag_type int	Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4
tag_id string	ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

nfc/inject_tag_stop

Pretends that a tag was detected by the NFC reader. The tag is only used to stop a charging session. The spoofed tag is always the last entry in nfc/seen_tags

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/nfc/inject_tag_stop -d '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/nfc/inject_tag_stop -m '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

Name	Description
tag_type int	Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4
tag_id string	ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

nfc/config

The NFC configuration.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/nfc/config

{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}

Write

curl http://$HOST/nfc/config -d '{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/nfc/config

{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}

Write

With MQTT on $PREFIX/nfc/config_update

mosquitto_pub -h $BROKER -t $PREFIX/nfc/config_update -m '{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}'

Name	Description
deadtime_post_start int (s)	Allows stopping a charging session with an NFC tag only after this time to avoid accidental operation.
authorized_tags object[16]	A list of authorized tags. [0..15] - An authorized NFC tag Name Description user_id int ID of the user this tag is assigned to, or 0 if it is not assigned to any user. tag_type int Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

warp2

nfc/seen_tags

The NFC tags most recently seen by the charger.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Read

curl http://$HOST/nfc/seen_tags

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/nfc/seen_tags

[
  { "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE", "last_seen": 22724083 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "01:23:AB:3D", "last_seen": 10753 }
]

Index	Description
[0..7] object	A seen NFC tag Name Description tag_type int Type of the tag 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D last_seen int (ms) Time in milliseconds since the tag was last seen.
[8] object	The tag spoofed by nfc/inject_tag Name Description tag_type int Type of the tag 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D last_seen int (ms) Time in milliseconds since the tag was last seen.

nfc/inject_tag

Pretends that a tag was detected by the NFC reader. This can be used to start or stop a charging session for a specific user via the API. Analogous to the physical use of a tag, the charging session is alternately authorized or blocked with each API call. See nfc/inject_tag_start and nfc/inject_tag_stop for more precise control. The spoofed tag is always the last entry in nfc/seen_tags

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Write

curl http://$HOST/nfc/inject_tag -d '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/nfc/inject_tag -m '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

Name	Description
tag_type int	Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4
tag_id string	ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

nfc/inject_tag_start

Pretends that a tag was detected by the NFC reader. The tag is only used to start a charging session. The spoofed tag is always the last entry in nfc/seen_tags

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Write

curl http://$HOST/nfc/inject_tag_start -d '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/nfc/inject_tag_start -m '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

Name	Description
tag_type int	Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4
tag_id string	ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

nfc/inject_tag_stop

Pretends that a tag was detected by the NFC reader. The tag is only used to stop a charging session. The spoofed tag is always the last entry in nfc/seen_tags

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Write

curl http://$HOST/nfc/inject_tag_stop -d '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/nfc/inject_tag_stop -m '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

Name	Description
tag_type int	Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4
tag_id string	ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

nfc/config

The NFC configuration.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Read

curl http://$HOST/nfc/config

{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}

Write

curl http://$HOST/nfc/config -d '{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/nfc/config

{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}

Write

With MQTT on $PREFIX/nfc/config_update

mosquitto_pub -h $BROKER -t $PREFIX/nfc/config_update -m '{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}'

Name	Description
deadtime_post_start int (s)	Allows stopping a charging session with an NFC tag only after this time to avoid accidental operation.
authorized_tags object[32]	A list of authorized tags. [0..31] - An authorized NFC tag Name Description user_id int ID of the user this tag is assigned to, or 0 if it is not assigned to any user. tag_type int Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

warp3

nfc/seen_tags

The NFC tags most recently seen by the charger.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Read

curl http://$HOST/nfc/seen_tags

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/nfc/seen_tags

[
  { "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE", "last_seen": 22724083 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "01:23:AB:3D", "last_seen": 10753 }
]

Index	Description
[0..7] object	A seen NFC tag Name Description tag_type int Type of the tag 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D last_seen int (ms) Time in milliseconds since the tag was last seen.
[8] object	The tag spoofed by nfc/inject_tag Name Description tag_type int Type of the tag 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D last_seen int (ms) Time in milliseconds since the tag was last seen.

nfc/inject_tag

Pretends that a tag was detected by the NFC reader. This can be used to start or stop a charging session for a specific user via the API. Analogous to the physical use of a tag, the charging session is alternately authorized or blocked with each API call. See nfc/inject_tag_start and nfc/inject_tag_stop for more precise control. The spoofed tag is always the last entry in nfc/seen_tags

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Write

curl http://$HOST/nfc/inject_tag -d '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/nfc/inject_tag -m '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

Name	Description
tag_type int	Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4
tag_id string	ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

nfc/inject_tag_start

Pretends that a tag was detected by the NFC reader. The tag is only used to start a charging session. The spoofed tag is always the last entry in nfc/seen_tags

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Write

curl http://$HOST/nfc/inject_tag_start -d '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/nfc/inject_tag_start -m '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

Name	Description
tag_type int	Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4
tag_id string	ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

nfc/inject_tag_stop

Pretends that a tag was detected by the NFC reader. The tag is only used to stop a charging session. The spoofed tag is always the last entry in nfc/seen_tags

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Write

curl http://$HOST/nfc/inject_tag_stop -d '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/nfc/inject_tag_stop -m '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

Name	Description
tag_type int	Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4
tag_id string	ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

nfc/config

The NFC configuration.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Read

curl http://$HOST/nfc/config

{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}

Write

curl http://$HOST/nfc/config -d '{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/nfc/config

{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}

Write

With MQTT on $PREFIX/nfc/config_update

mosquitto_pub -h $BROKER -t $PREFIX/nfc/config_update -m '{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}'

Name	Description
deadtime_post_start int (s)	Allows stopping a charging session with an NFC tag only after this time to avoid accidental operation.
authorized_tags object[32]	A list of authorized tags. [0..31] - An authorized NFC tag Name Description user_id int ID of the user this tag is assigned to, or 0 if it is not assigned to any user. tag_type int Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

wem

Not supported on this hardware!

wem2

Not supported on this hardware!

any

nfc/seen_tags

The NFC tags most recently seen by the charger.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/nfc/seen_tags

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/nfc/seen_tags

[
  { "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE", "last_seen": 22724083 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "", "last_seen": 0 },
  { "tag_type": 0, "tag_id": "01:23:AB:3D", "last_seen": 10753 }
]

Index	Description
[0..7] object	A seen NFC tag Name Description tag_type int Type of the tag 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D last_seen int (ms) Time in milliseconds since the tag was last seen.
[8] object	The tag spoofed by nfc/inject_tag Name Description tag_type int Type of the tag 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D last_seen int (ms) Time in milliseconds since the tag was last seen.

nfc/inject_tag

Pretends that a tag was detected by the NFC reader. This can be used to start or stop a charging session for a specific user via the API. Analogous to the physical use of a tag, the charging session is alternately authorized or blocked with each API call. See nfc/inject_tag_start and nfc/inject_tag_stop for more precise control. The spoofed tag is always the last entry in nfc/seen_tags

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/nfc/inject_tag -d '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/nfc/inject_tag -m '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

Name	Description
tag_type int	Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4
tag_id string	ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

nfc/inject_tag_start

Pretends that a tag was detected by the NFC reader. The tag is only used to start a charging session. The spoofed tag is always the last entry in nfc/seen_tags

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/nfc/inject_tag_start -d '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/nfc/inject_tag_start -m '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

Name	Description
tag_type int	Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4
tag_id string	ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

nfc/inject_tag_stop

Pretends that a tag was detected by the NFC reader. The tag is only used to stop a charging session. The spoofed tag is always the last entry in nfc/seen_tags

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/nfc/inject_tag_stop -d '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/nfc/inject_tag_stop -m '{ "tag_type": 0, "tag_id": "01:23:AB:3D" }'

Name	Description
tag_type int	Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4
tag_id string	ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D

nfc/config

The NFC configuration.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/nfc/config

{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}

Write

curl http://$HOST/nfc/config -d '{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/nfc/config

{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}

Write

With MQTT on $PREFIX/nfc/config_update

mosquitto_pub -h $BROKER -t $PREFIX/nfc/config_update -m '{
  "authorized_tags": [
    { "user_id": 1, "tag_type": 2, "tag_id": "04:E3:B2:27:39:AD:FE" },
    { "user_id": 2, "tag_type": 0, "tag_id": "01:23:AB:3D" }
  ]
}'

Name	Description
deadtime_post_start int (s)	Allows stopping a charging session with an NFC tag only after this time to avoid accidental operation.
authorized_tags object[..]	A list of authorized tags. (Only WARP 1) [0..15] - An authorized NFC tag Name Description user_id int ID of the user this tag is assigned to, or 0 if it is not assigned to any user. tag_type int Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D (Only WARP 2 and WARP 3) [0..31] - An authorized NFC tag Name Description user_id int ID of the user this tag is assigned to, or 0 if it is not assigned to any user. tag_type int Type of the tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Depending on tag type, up to 10 hex bytes separated by ':'. e.g. 01:23:AB:3D