Interface: tos.chips.cc1000.LowPowerListening

interface LowPowerListening

Low Power Listening interface

Author:
David Moss
Jonathan Hui

Commands
command uint16_t dutyCycleToSleepInterval(uint16_t dutyCycle) Convert a duty cycle, in units of [percentage*100], to the sleep interval of the mote in milliseconds
command uint16_t getLocalDutyCycle()
command uint16_t getLocalSleepInterval()
command uint16_t getRxDutyCycle(message_t *msg)
command uint16_t getRxSleepInterval(message_t *msg)
command void setLocalDutyCycle(uint16_t dutyCycle) Set this node's radio duty cycle rate, in units of [percentage*100].
command void setLocalSleepInterval(uint16_t sleepIntervalMs) Set this this node's radio sleep interval, in milliseconds.
command void setRxDutyCycle(message_t *msg, uint16_t dutyCycle) Configure this outgoing message so it can be transmitted to a neighbor mote with the specified Rx duty cycle rate.
command void setRxSleepInterval(message_t *msg, uint16_t sleepIntervalMs) Configure this outgoing message so it can be transmitted to a neighbor mote with the specified Rx sleep interval.
command uint16_t sleepIntervalToDutyCycle(uint16_t sleepInterval) Convert a sleep interval, in units of [ms], to a duty cycle in units of [percentage*100]

Commands - Details

dutyCycleToSleepInterval

command uint16_t dutyCycleToSleepInterval(uint16_t dutyCycle)

Convert a duty cycle, in units of [percentage*100], to the sleep interval of the mote in milliseconds

Parameters:
dutyCycle - The duty cycle in units of [percentage*100]
Returns:
The equivalent sleep interval, in units of [ms]

getLocalDutyCycle

command uint16_t getLocalDutyCycle()

Returns:
this node's radio duty cycle rate, in units of [percentage*100]

getLocalSleepInterval

command uint16_t getLocalSleepInterval()

Returns:
the local node's sleep interval, in [ms]

getRxDutyCycle

command uint16_t getRxDutyCycle(message_t *msg)

Returns:
the destination node's duty cycle configured in this message in units of [percentage*100]

getRxSleepInterval

command uint16_t getRxSleepInterval(message_t *msg)

Returns:
the destination node's sleep interval configured in this message

setLocalDutyCycle

command void setLocalDutyCycle(uint16_t dutyCycle)

Set this node's radio duty cycle rate, in units of [percentage*100]. For example, to get a 0.05% duty cycle, call LowPowerListening.setDutyCycle(5); // or equivalently... call LowPowerListening.setDutyCycle(00005); // for better readability? For a 100% duty cycle (always on), call LowPowerListening.setDutyCycle(10000); This is the equivalent of setting the local sleep interval explicitly.

Parameters:
dutyCycle - The duty cycle percentage, in units of [percentage*100]

setLocalSleepInterval

command void setLocalSleepInterval(uint16_t sleepIntervalMs)

Set this this node's radio sleep interval, in milliseconds. Once every interval, the node will sleep and perform an Rx check on the radio. Setting the sleep interval to 0 will keep the radio always on. This is the equivalent of setting the local duty cycle rate.

Parameters:
sleepIntervalMs - the length of this node's Rx check interval, in [ms]

setRxDutyCycle

command void setRxDutyCycle(message_t *msg, uint16_t dutyCycle)

Configure this outgoing message so it can be transmitted to a neighbor mote with the specified Rx duty cycle rate. Duty cycle is in units of [percentage*100], i.e. 0.25% duty cycle = 25.

Parameters:
msg - Pointer to the message that will be sent
dutyCycle - The duty cycle of the receiving mote, in units of [percentage*100]

setRxSleepInterval

command void setRxSleepInterval(message_t *msg, uint16_t sleepIntervalMs)

Configure this outgoing message so it can be transmitted to a neighbor mote with the specified Rx sleep interval.

Parameters:
'message_t* ONE msg' Pointer to the message that will be sent
sleepInterval - The receiving node's sleep interval, in [ms]

sleepIntervalToDutyCycle

command uint16_t sleepIntervalToDutyCycle(uint16_t sleepInterval)

Convert a sleep interval, in units of [ms], to a duty cycle in units of [percentage*100]

Parameters:
sleepInterval - The sleep interval in units of [ms]
Returns:
The duty cycle in units of [percentage*100]