Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 123]

►NCsMath
CInterval	Represents an interval by two unsigned integers [base, base + diff]
►Nfunc
►Ndetail
Cempty_struct
Cfunction_manager
Cfunction_manager_inplace_specialization
Cfunction_manager_inplace_specialization< T, Allocator, typename std::enable_if<!is_inplace_allocated< T, Allocator >::value >::type >
Cfunctor_padding
Cfunctor_type
Cis_inplace_allocated
Cis_valid_function_argument
Cis_valid_function_argument< function< Result(Arguments...)>, Result(Arguments...)>
Cis_valid_function_argument< T, Result(Arguments...)>
Cmanager_storage_type
Ctypedeffer
Ctypedeffer< Result, Argument >
Ctypedeffer< Result, First_Argument, Second_Argument >
Cforce_function_heap_allocation
Cfunction
Cfunction< Result(Arguments...)>
►NMeshUtil	Mesh utils without dependencies on mesh SDK
Ccs_mesh_queue_item_meta_data_t	Data needed in each model queue
Ccs_mesh_queue_item_t	Struct to queue an item
►NMsws
CState	Wrapper class for internal state of the Msws generator
►Nstd
Cuses_allocator< func::function< Result(Arguments...)>, Allocator >
Cad_data_type_selector_t
CADC	Analog-Digital conversion
Cadc_buffer_t	Struct communicated from the ADC class when it's done sampling a buffer
Cadc_channel_config_result_t	Result struct after configuring an ADC channel
Cadc_channel_config_t	Struct to configure an ADC channel
Cadc_config_t	Struct to configure the ADC
CAdcBuffer	Class that keeps up the buffers used for ADC
Cadv_background_parsed_t	Parsed background advertisement
Cadv_background_parsed_v1_t
Cadv_background_t	Unparsed background advertisement
CAdvertiser
CAES	Class that implements AES encryption
Casset_filter_cmd_commit_filter_changes_t
Casset_filter_cmd_get_filter_summaries_ret_t
Casset_filter_cmd_remove_filter_t
Casset_filter_cmd_upload_filter_t
Casset_filter_flags_t
Casset_filter_runtime_data_t	Runtime meta data associated to an asset filter that is not persisted to flash
Casset_filter_summary_t
Casset_filters_version_t
Casset_id_t
Casset_record_t
Casset_report_uart_id_t
Casset_report_uart_mac_t	A packet that represents RSSI data about an asset received by a particular Crownstone
CAssetAcceptedEvent
CAssetFilter	Class that contains all data required for an asset filter:
CAssetFilterData	Class that contains all persisted data required for an asset filter:
CAssetFiltering
CAssetFilterInput	This file defines several accessor classes for structures that relate to the trackable parser
CAssetFilterMetadata	Class that contains all persisted metadata required for an asset filter:
CAssetFilterOutput	Class that determines the output method and data of an asset that passed the filter
CAssetFilterStore	Keeps up the asset filters
CAssetFilterSyncer	Class that takes care of synchronizing the asset filters between crownstones
►CAssetForwarder	AssetForwarder makes it possible for the AssetFiltering to merge mesh messages when they have very similar data
Coutbox_msg_t
CAssetHandlerMac
CAssetHandlerShortId
CAssetStore
CBackgroundAdvertisementHandler	Class that parses advertisements for background broadcasts
CBaseClass	BaseClass
CBehaviour	Class to derrive behaviours from, centralizing common variables such as from and until times
Cbehaviour_debug_t
Cbehaviour_settings_t	Behaviour settings
CBehaviourHandler
CBehaviourMutation	Describes a recent change event of the behaviour store
CBehaviourStore	Keeps track of the behaviours that are active on this crownstone
CBitmaskVarSize	Class that holds a bitmask of variable size
Cble_central_connect_t
Cble_central_discover_t
Cble_central_discovery_t	Describes a service or characteristic that has been discovered
Cble_central_notification_t
Cble_central_read_result_t
Cble_central_read_t
Cble_central_write_result_t
Cble_central_write_t
Cble_connected_t
CBleCentral	Class that enables you to connect to a device, and perform write or read operations
CBleHandler
Cboards_config_t	Board configuration
CBufferAccessor	Base class for a buffer accessor object
CCharacteristic	Characteristic of generic type T
CCharacteristic< buffer_ptr_t >	The base class is already using a buffer as value
CCharacteristic< const char * >	A string value
Ccharacteristic_config_t
►CCharacteristicBase	Base class for a BLE characteristic
Cchunked_notification_t
CCharacteristicBuffer	CharacteristicBuffer is a byte array with header
CCharacteristicReadBuffer	Buffer used to hold plain text data that is read by the user
CCharacteristicWriteBuffer	Buffer used to hold plain text characteristic data written by the user
CCircularBuffer	Circular Buffer implementation
CCircularDifferentialBuffer	Differential Buffer implementation
Ccmd_source_t	Struct that tells where a command originated from
Ccmd_source_with_counter_t	Struct that tells where a command originated from
Ccommand_adv_claim_t	Struct used to prevent double handling of similar command advertisements
Ccommand_adv_header_t
CCommandAdvHandler
CCommandHandler	Every command from an external device such as a smartphone goes through the CommandHandler
CCOMP	Class that enables you to get events when a the voltage on an AIN pin goes over or below a given threshold
CComponent	Helper class to manage decoupling of components
CConnectionEncryption
Ccontrol_command_packet_t
Ccontrol_packet_header_t	Header of a control packet
Ccontrol_packet_t	Control packet
CControlPacketAccessor
CCoroutine	A coroutine essentially is a throttling mechanism: it takes in a tick-event or tick count and executes its action when the time (number of ticks) passed between the last call and the current one is larger than the time the action reported the next call needed to wait
Ccoroutine_t	Struct with the context to jump between bluenet and coroutine
CCrownstone	Crownstone encapsulates all functionality, stack, services, and configuration
CCrownstoneCentral	Class to connect to another crownstone, and write control commands
CCrownstoneManufacturer	CrownstoneManufacturer defines the different types of developed devices for within the advertisement packets
CCrownstoneService	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: Oct 22, 2014 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
Ccs_adc_channel_swaps_t
Ccs_adc_restarts_t
Ccs_async_result_t
Ccs_bootloader_info_t
Ccs_central_connect_t
Ccs_central_write_result_t	Result of writing a control command
Ccs_central_write_t
Ccs_const_data_t	Variable length data encapsulation in terms of length and pointer to data
Ccs_data_t	Packets (structs) that are used internally in the firmware, and can be changed freely
Ccs_external_state_item_t	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: May 22, 2019 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
Ccs_gpio_init_t
Ccs_gpio_read_t
Ccs_gpio_update_t
Ccs_gpio_write_t
Ccs_gpregret_result_t
Ccs_id_list_t
Ccs_legacy_multi_switch_item_t
Ccs_legacy_multi_switch_t
Ccs_mesh_iv_index_t	Same as mesh_opt_iv_index_persist_data_legacy_t
Ccs_mesh_iv_index_v5_t	Same as mesh_opt_iv_index_persist_data_t
Ccs_mesh_model_msg_asset_filter_version_t
Ccs_mesh_model_msg_asset_report_id_t
Ccs_mesh_model_msg_asset_report_mac_t
Ccs_mesh_model_msg_ctrl_cmd_header_ext_t
Ccs_mesh_model_msg_ctrl_cmd_header_t
Ccs_mesh_model_msg_device_heartbeat_t
Ccs_mesh_model_msg_device_list_size_t
Ccs_mesh_model_msg_device_register_t
Ccs_mesh_model_msg_device_token_t
Ccs_mesh_model_msg_multi_switch_item_t
Ccs_mesh_model_msg_neighbour_rssi_t
Ccs_mesh_model_msg_profile_location_t
Ccs_mesh_model_msg_result_header_t
Ccs_mesh_model_msg_state_0_t
Ccs_mesh_model_msg_state_1_t
Ccs_mesh_model_msg_state_header_ext_t
Ccs_mesh_model_msg_state_header_t
Ccs_mesh_model_msg_stone_mac_t
Ccs_mesh_model_msg_sync_request_t
Ccs_mesh_model_msg_test_t
Ccs_mesh_model_msg_time_sync_t	Packed version of time_sync_message_t
Ccs_mesh_model_msg_time_t
Ccs_mesh_msg_t	Struct to communicate a mesh message
Ccs_mesh_seq_number_v5_t	Same as mesh_opt_seqnum_persist_data_t
Ccs_power_samples_header_t
Ccs_power_samples_request_t
Ccs_ram_stats_t
Ccs_result_t
Ccs_state_data_t	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: Oct 9, 2019 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
Ccs_state_store_queue_t	Struct for queuing operations
Ccs_switch_history_header_t
Ccs_switch_history_item_t
Ccs_twi_init_t
Ccs_twi_read_t
Ccs_twi_write_t
Ccs_type_and_id_t
Ccs_uicr_data_t	Struct with all the Crownstone fields in UICR
Ccs_uuid128_t
Ccuckoo_compressed_fingerprint_t
Ccuckoo_extended_fingerprint_t	Representation of an object (O) in this filter comprises of a fingerprint (F) and a the bucket index (A) where this fingerprint is located
Ccuckoo_filter_data_t	Data content of the cuckoo filter
CCuckooFilter	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: 02 Apr., 2021 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
Cdevice_address_t
CDeviceInformationService	The DeviceInformationService is a BLE service that gives info on hardware and firmware revisions
Cdifferential_buffer_fixed_t	Struct with fixed length, useful when sending as payload
Cdifferential_buffer_t	Struct with dynamic length, used by StackBuffer class
CDifferentialBuffer	Differential Buffer implementation
CDimmer	Class that provides a dimmer
Cenable_message_payload_t
Cenable_scanner_message_payload_t
CEncryptedBuffer	Buffer used to hold encrypted characteristic data
Cencryption_header_encrypted_t	Encryption header that's encrypted
Cencryption_header_t	Encryption header that's not encrypted
Cencryption_nonce_t	Nonce used for encryption
Cevent_t	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: Oct 9, 2019 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
CEventDispatcher	Event dispatcher
CEventListener	Event listener
Cexact_match_filter_data_t	Data content of the exact match filter
CExactMatchFilter
CExtendedSwitchBehaviour	A smart timer behaviour is a switch behaviour that is allowed to extend itself passed the until time defined
CExternalStates	Class that keeps up states of other stones
Cfactory_reset_message_payload_t
CFactoryReset
CFilterInterface	Used in AssetFiltering as a generic way to query a filter for containment and assetId
Cfixed_tuple	A fixed tuple is a vector with a templated type and a reserved capacity
CGpio
CGpRegRet	Class to write and read the GPREGRET
Chigh_resolution_time_stamp_t	Versioned timestamp with milliseconds precision
Chub_data_header_t
CIBeacon	Implementation of the iBeacon specification
Cibeacon_config_id_packet_t	Packet to change ibeacon config ID
Cinternal_multi_switch_item_cmd_t	A single multi switch command
Cinternal_multi_switch_item_t	A single multi switch packet, with target id
Cinternal_register_tracked_device_packet_t
Cinternal_tracked_device_heartbeat_packet_t
CIpcRamBluenet	Class to operate on bluenet to bluenet IPC ram
CKeysAndAccess	Class to get keys based on access level, and to check access levels
Cled_message_payload_t
CLollipop	Increment administration object with 'none' value default
Cmac_address_t	MAC address struct, with some useful functions
Cmasked_ad_data_type_selector_t
CMedianFilter
CMemUsageTest
CMesh	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: 12 Apr., 2019 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
Cmesh_control_command_packet_flags_t	Flags to determine how to send the mesh message
Cmesh_control_command_packet_header_t	Mesh control command header packet
Cmesh_control_command_packet_t	Mesh control command packet
Cmesh_reply_t
Cmesh_state_part_0_t
Cmesh_state_part_1_t
Cmesh_topo_mac_result_t
Cmesh_topology_neighbour_research_rssi_t	Message format to be sent over uart
Cmesh_topology_neighbour_rssi_uart_t
CMeshAdvertiser
CMeshCore	Class that:
►CMeshModelMulticast	Class that:
Ccs_multicast_queue_item_t
►CMeshModelMulticastAcked	Class that:
Ccs_multicast_acked_queue_item_t
►CMeshModelMulticastNeighbours	Class that:
Ccs_multicast_queue_item_t
CMeshModelSelector	Class that selects which model to use to send a message
►CMeshModelUnicast	Class that:
Ccs_unicast_queue_item_t
CMeshMsgEvent
►CMeshMsgHandler	Class that:
Ccs_mesh_model_ext_state_t
CMeshMsgSender	Class that:
CMeshPacketTraits
CMeshPacketTraits< CS_MESH_MODEL_TYPE_ASSET_FILTER_VERSION >
CMeshPacketTraits< CS_MESH_MODEL_TYPE_ASSET_INFO_ID >
CMeshPacketTraits< CS_MESH_MODEL_TYPE_ASSET_INFO_MAC >
CMeshPacketTraits< CS_MESH_MODEL_TYPE_NEIGHBOUR_RSSI >
CMeshPacketTraits< CS_MESH_MODEL_TYPE_RSSI_DATA >
CMeshPacketTraits< CS_MESH_MODEL_TYPE_RSSI_PING >
CMeshPacketTraits< CS_MESH_MODEL_TYPE_SET_BEHAVIOUR_SETTINGS >
CMeshPacketTraits< CS_MESH_MODEL_TYPE_STONE_MAC >
CMeshPacketTraits< CS_MESH_MODEL_TYPE_TEST >
CMeshPacketTraits< CS_MESH_MODEL_TYPE_TIME_SYNC >
CMeshScanner	Class that handles scans from the mesh
►CMeshTopology
Cneighbour_node_t
►CMeshTopologyResearch	This class/component keeps track of the rssi distance of a crownstone to its neighbors (i.e
CTimingSettings
CMicroapp	Class that enables the feature to run microapps on the firmware
Cmicroapp_advertise_request_t
Cmicroapp_binary_header_t	Header of a microapp binary
Cmicroapp_coroutine_args_t	The IPC buffers can be used to bootstrap communication between microapp and bluenet
Cmicroapp_ctrl_header_t
Cmicroapp_data_t	Keeps up data for a microapp
Cmicroapp_info_t	Packet with all info required to upload a microapp, and to see the status of already uploaded microapps
Cmicroapp_message_internal_t
Cmicroapp_message_t
Cmicroapp_sdk_version_t	SDK version: determines the API / protocol between microapp and firmware
Cmicroapp_soft_interrupt_registration_t	Struct for keeping track of registered interrupts from the microapp
Cmicroapp_state_t	State of tests of a microapp, also stored in flash
Cmicroapp_status_t	Status of a microapp
Cmicroapp_upload_internal_t
Cmicroapp_upload_t
CMicroappController	The class MicroappController has functionality to store a second app (and perhaps in the future even more apps) on another part of the flash memory
CMicroappInterruptHandler	The class MicroappRequestHandler has functionality to store a second app (and perhaps in the future even more apps) on another part of the flash memory
CMicroappRequestHandler	The class MicroappRequestHandler has functionality to store a second app (and perhaps in the future even more apps) on another part of the flash memory
CMicroappSdkUtil
CMicroappService
CMicroappStorage	Class to store microapps on flash
Cmulti_switch_item_t	A single multi switch item
Cmulti_switch_t	Multi switch packet
CMultiSwitchHandler
CNearestCrownstoneTracker	This class implements the in-mesh computation of which crownstone is nearest to a 'trackable' device
Copcode_message_payload_t
Cpin_info_t
►CPowerSampling	Sample power
Cpower_t	Struct that defines the buffer received from the ADC sampler in scanning mode
CPresenceCondition
►CPresenceHandler	Keeps up all the locations each profile is present in
CPresenceRecord
CProfileLocation
CPresencePredicate
CPresenceStateDescription	Class that holds the presence of a profile
Cprofile_location_t
CPWM	Pulse Wide Modulation class
Cpwm_channel_config_t
Cpwm_config_t
CRandomGenerator	Crownstones pseudo random number generator wrapper
CRC5	Class that implements RC5 encryption
CRecognizeSwitch	Authors: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: March 23, 2018 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
Cregister_tracked_device_packet_t
CRelay	Class that provides a bi-stable relay
Creset_delayed_t
Cresult_packet_header_t	Header of a result packet
Cresult_packet_t	Result packet
CResultPacketAccessor
CRNG	Random number generator using softdevice called peripheral
Crssi_and_channel_float_t
Crssi_and_channel_t
Crssi_data_message_t
Crssi_data_t	The data in this packet contains information about a bluetooth channel between this crownstone and the one with id sender_id
Crssi_ping_message_t	Sent from a crownstone when it has too little rssi information from its neighbors
CRTC	Wrapper class for RTC functions
CSafeSwitch	Class that takes care of safety of switch
Cscanned_device_t	Scanned device
CScanner	Scanner scans for BLE devices
CSdhStateHandler
CService	Base class for a BLE service
Cservice_data_encrypted_alternative_state_t	State of this crownstone
Cservice_data_encrypted_error_t	In case the crownstone has errors, this will be advertised next to the state
Cservice_data_encrypted_ext_error_t	Errors of another crownstone
Cservice_data_encrypted_ext_state_t	State of another crownstone
Cservice_data_encrypted_microapp_t	Microapp data that will be encrypted
Cservice_data_encrypted_state_t	State of this crownstone
Cservice_data_encrypted_t	This data is encrypted
Cservice_data_hub_state_flags_t
Cservice_data_hub_state_t
Cservice_data_microapp_flags_t
Cservice_data_setup_state_t
Cservice_data_setup_t	Setup data
Cservice_data_state_extra_flags_t
Cservice_data_state_flags_t
Cservice_data_t	Service data
CServiceData
Csession_data_t
Cset_ibeacon_config_id_packet_t
CSetup	Setup class
Csetup_data_t
CSetupService	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: Oct 22, 2014 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
CSmartSwitch	Class that:
CSocHandler
CStack	NRF51822 specific implementation of the BLEStack
Cstack_buffer_fixed_t	Struct with fixed length, useful when sending as payload
Cstack_buffer_t	Struct with dynamic length, used by StackBuffer class
Cstack_params_t	Struct with all the state we need for a coroutine
CStackBuffer
CState	Stores state values in RAM and/or FLASH
Cstate_errors_t	State errors: collection of errors that influence the switch behaviour
Cstate_external_stone_t	Struct to communicate received state of other stones
Cstate_packet_header_t	State get/set header packet
CStorage	Class to store items persistently in flash (persistent) memory
CStore	A variable size storage utility for objects of type RecordType with absolute maximum MaxItemCount
CStreamBufferAccessor	A wrapper around a raw uint8_t array (buffer) to easily read, write from it
Csun_time_t
Cswitch_message_payload_t
Cswitch_state_t	Switch state: combination of relay and dimmer state
CSwitchAggregator	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: Sep 26, 2019 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
CSwitchBehaviour	Object that defines when a state transition should occur
CSystemTime	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: Sep 24, 2019 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
Ct2t_entry_t
CTapToToggle	Class that toggles the switch when a device, like a phone, is held close to the Crownstone
CTemperatureGuard	Check if the temperature exceeds a certain threshold
CTestAccess
CTestCentral	Class to test the BleCentral class
CTestCrownstoneCentral	Class to test the BleCentral class
CTime	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: Sep 24, 2019 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
Ctime_sync_message_t	Event sent over the internal event bus upon reception of new mesh time stamp msg
CTimeOfDay	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: Sep 24, 2019 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
CTimer	Timer on top of the timer peripheral
Ctracked_device_heartbeat_packet_t
CTrackedDevice
CTrackedDevices	Class that keeps up devices to be tracked
Ctuple	A tuple is a vector with a templated type and a public constructor
CTwi	Class that implements twi/i2c
CTwilightBehaviour
CTwilightHandler
Cuart_encrypted_data_header_t	Encrypted header for encrypted uart msg
Cuart_encrypted_msg_header_t	Non-encrypted header for encrypted uart msg
Cuart_msg_adc_channel_config_t
Cuart_msg_current_t
Cuart_msg_header_t	UART message, either non-encrypted, or after decryption
Cuart_msg_heartbeat_t
Cuart_msg_hello_t
Cuart_msg_hub_data_reply_header_t
Cuart_msg_log_arg_header_t
Cuart_msg_log_array_header_t
Cuart_msg_log_common_header_t
Cuart_msg_log_header_t
Cuart_msg_mesh_result_packet_header_t
Cuart_msg_power_t
Cuart_msg_session_nonce_reply_t
Cuart_msg_session_nonce_t
Cuart_msg_size_header_t	Very first header, right after the start byte
Cuart_msg_status_reply_flags_t
Cuart_msg_status_reply_t
Cuart_msg_status_user_flags_t	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: Jan 17, 2018 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
Cuart_msg_status_user_t
Cuart_msg_tail_t	Final bytes
Cuart_msg_voltage_t
Cuart_msg_wrapper_header_t	Wrapper header, after the initial size field
CUartCommandHandler
CUartConnection	Class that:
CUartHandler	Class that implements the binary UART protocol
CUUID	Class that enables the use of 128 bit service UUIDs
CVarianceAggregator	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: Nov 29, 2020 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
CWatchdog	Class that implements the watchdog timer