...
Car Counters Parking Structure
Nwave Parking structure constists of hierarhy objects called 's parking structure is organized into a hierarchical system consisting of Projects, Zones, Levels, Groups, and Positions. The Project is a required highest level object of the hierarchy. You can unite a few Zones in a project and give an access for a user only to this project or set of project.
Zone represent a single parking and it is required too.
Level is an optional object of parking Here's an overview of these hierarchy objects:
Project: This is the highest-level object in the hierarchy and is required. Projects allow you to group and manage Zones. Users can be granted access to specific projects or a set of projects.
Zone: A Zone represents a single parking area, and it is also a required object. Each parking area is defined as a Zone.
Level: Levels are optional objects in the hierarchy. You can add
...
Levels to
...
Zones if your parking
...
facility has multiple floors or levels. For example, in a multi-level car parking structure.
Group
...
: Groups allow you to unite Positions
...
within them and describe
...
lower-
...
level areas
...
within a Zone or Level.
...
Groups must be added to a Level or directly to a Zone
...
.
...
Additionally, Groups
...
can specify the type of parking area.
...
If you are using Car Counters, the
...
Group Type should be set to
...
"Standalone Car
...
Counter."
Position: Positions should be placed
...
within Groups.
...
Each Position can
...
only
...
belong to a single Group.
...
However, in the case of using Car Counters,
...
sensor data from a single sensor can be applied to two groups
...
when the sensor is placed
...
at a transition point between those groups. This specific behavior can be
...
configured with
...
the assistance of Nwave Team.
...
By utilizing these hierarchy objects helps to describe a parking and allows you to place Positions in , you can effectively describe the structure of your parking facility and place Positions within the correct hierarchy. For example, if :
If you want to describe a plane parking
...
area with two zones, "Simple Spaces" and "EV Charging Spaces," you can register the hierarchy
...
as follows:
Project: My Parking Project
Zone: My Plane Parking
Group: Simple Spaces
Position: Entrance to parking lot
Position: Transition to EV charging area
Group: EV charging spaces
Position: Transition to Simple Spaces area
Position: Exit from parking lot
...
If you
...
need to describe a multi-storey car parking (MSCP) with
...
three floors, you can
...
incorporate Levels:
Project: My Parking Project
Zone: My MSCP
Level: Floor 0
Group: Floor 0 Group
Position: Entrance to MSCP
Position: Exit from MSCP
Position: Transition to Floor 1
Level: Floor 1
Group: Floor 1 Group
Position: Transition to Floor 2
Position: Transition to Floor 0
Level: Floor 2
Group: Floor 2 Group
Position: Transition to Floor 1
You can read more about Nwave Parking Hierachy object adding in the following documentation:This hierarchy structure allows for detailed organization and management of parking facilities. For more information on adding Nwave Parking Hierarchy objects, please refer to the provided documentation.
| Note |
|---|
Final car counter zone configuration only with help of Nwave Support. Please, contact to manager to getting car counter zone configuredPlease note that full car counters support is currently under construction. Nwave currently offers user support for configuring car counters only for single-group zones. If you have the need to split a zone into multiple groups or use car counters to obtain occupancy information for each floor in a multi-level car parking facility, we kindly request that you reach out to Nwave Support for further assistance. Nwave is committed to providing comprehensive support and solutions to meet your specific requirements. |
API
Before using API you need to create Authorization Token using this instructions Generating Authorization Tokens
Analytics API
Nwave Cloud offers a wide range of analytical APIs, allowing you to access both raw and aggregated occupancy data. For more detailed information about the Car Counter Analytics API, please refer to the documentation page
Car Counter Group Configuration
Car Counter Groups supports only two configuration API
...
:
Group Capacity - the total amount of parking spaces in the group
Occupancy Correction - allows users to adjust group occupancy before live running a project or after resolving issues with equipment.
Group Capacity Setup API
This API endpoint empowers you to configure the total number of parking spaces within a group identified by its unique {group_id}.
URL:
https://api.nwave.io/
...
car_counters/
...
Method: GET
Query arguments:
group_by - grouping result by project/zone/level/group. Allowed values:
project,zone,group,levelproject_id - one or many project IDs
zone_id - one or many zone IDs
level_id - one or many level IDs
floor_number - one or many floor numbers
group_id - one or many group IDs
group_custom_id - one or many group custom IDs
order_by - ordering key. Allowed values:
name,occupied. Default:nameorder_direction - ordering by ascending or descending. Allowed values:
asc,desc. Default:ascpagination:
limit - max number of objects in the response. Default:
100offset - number of skipped objects from the beginning of result. Default:
0
Example:
...
v1/group/{group_id}/capacityMethod: PUT
Request Body:
| Code Block | ||
|---|---|---|
| ||
{"capacity": INT} |
Example:
This request illustrates how to set a capacity of 100 spaces for a group with ID 1234:
| Code Block | ||
|---|---|---|
| ||
curl --location --request GETPUT 'https://api.nwave.io/analytics/v1/car_counters/realtimev1/occupancy_summary?group_by=group&zone_id=123'group/1234/capacity' \ --header 'xX-Auth-Token: XXXXXXXXXXXX' |
...
XXXXXXXXXXXXXXXXXXXXX' \
--data '{"capacity":100}' |
Use this API to efficiently manage and configure the parking space capacity for specific groups.
Occupancy Correction API
Group Occupancy Setup API
This API endpoint allows you to specify the number of occupied spaces within a group identified by its unique {group_id}. Optionally, you can include a timestamp in the request body to set the occupancy value for a specific time.
URL:
https://api.nwave.io
...
/
...
car_counters/
...
v1/
...
Method: GET
Query arguments:
group_by - grouping result by project/zone/level/group. Allowed values:
zonedate_from - UTC timestamp. Example:
2023-01-10date_till - UTC timestamp. Example:
2023-01-10project_id - one or many project IDs
zone_id - one or many zone IDs
level_id - one or many level IDs. Pass 0 to select groups out of level (directly in zone).
order_by - ordering key. Allowed values:
name,occupied. Default:nameorder_direction - ordering by ascending or descending. Allowed values:
asc,desc. Default:ascpagination:
limit - max number of objects in the response. Default:
100offset - number of skipped objects from the beginning of result. Default:
0
Example:
Requesting zone occupancy zone with ID 123 between 2022 Dec 10 and 2023 Jan 10:
...
group/{group_id}/occupancyMethod: PUT
Request Body:
| Code Block | ||
|---|---|---|
| ||
{
"occupied":INT,
"time": "2023-06-13T23:05:24.328Z" // optional
} |
Example:
This request demonstrates how to set the current occupancy of 35 spaces for a group with ID 1234:
| Code Block | ||
|---|---|---|
| ||
curl --location --request GETPUT 'https://api.nwave.io/analytics/v1/car_counters/v1/historygroup/chart/raw?group_by=zone&zone_id=123&date_from=2022-12-20&date_till=2023-02-10' 1234/occupancy' \ --header 'xX-Auth-Token: XXXXXXXXXXXX' |
Additional Materials
...
XXXXXXXXXXXXXXXXXXXXX' \
--data '{"occupied":35}' |
Use this API to efficiently manage and configure the occupancy status for specific groups, with the option to specify a timestamp for accurate tracking of occupancy changes.